itd-api / EventTransportContext

Interface: EventTransportContext

Defined in: events/transports/transport.ts:37

Что транспорт получает от клиента при подключении.

Extends

• Pick<ClientConnection, "baseUrl" | "authorize" | "fetch" | "baseHeaders" | "getToken">

Properties

authorize

readonly authorize: boolean;

Defined in: core/connection.ts:13

Разрешено ли соединению передавать Bearer-токен этому сервису.

Inherited from

ClientConnection.authorize

---

baseUrl

readonly baseUrl: string;

Defined in: core/connection.ts:11

Фактический HTTP(S)-адрес сервиса с учётом настроек клиента.

Inherited from

ClientConnection.baseUrl

---

fetch

readonly fetch: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Defined in: core/connection.ts:14

Call Signature

(input, init?): Promise<Response>;

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>;

MDN Reference

Parameters

input

string | URL | Request

init?

RequestInit

Returns

Promise<Response>

Inherited from

ClientConnection.fetch

---

onEvent

onEvent: (event) => void;

Defined in: events/transports/transport.ts:42

Сообщает о полученном событии.

Parameters

event

EventTransportFrame

Returns

void

---

onOpen

onOpen: () => void;

Defined in: events/transports/transport.ts:46

Вызывается, когда соединение установлено.

Returns

void

---

onParseError

onParseError: (error, raw) => void;

Defined in: events/transports/transport.ts:44

Сообщает о разобранном, но некорректном сообщении. Соединение при этом живёт.

Parameters

error

unknown

raw

string

Returns

void

---

signal

signal: AbortSignal;

Defined in: events/transports/transport.ts:40

Отмена подключения.

Methods

baseHeaders()

baseHeaders(url): Promise<Headers>;

Defined in: core/connection.ts:19

Заголовки платформы и сервиса без Bearer-токена.

Parameters

url

string

Returns

Promise<Headers>

Inherited from

ClientConnection.baseHeaders

---

getToken()

getToken(): Promise<string | null>;

Defined in: core/connection.ts:21

Текущий токен; способ его передачи выбирает транспорт.

Returns

Promise<string | null>

Inherited from

ClientConnection.getToken