itd-api / TransportContext

Interface: TransportContext

Defined in: realtime/transport.ts:10

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

Properties

baseHeaders

baseHeaders: (url) => Promise<Headers>;

Defined in: realtime/transport.ts:19

Общие заголовки клиента: User-Agent, X-Device-Id, заголовки конфигурации и cookie для указанного адреса.

Parameters

url

string

Returns

Promise<Headers>

---

baseUrl

baseUrl: string;

Defined in: realtime/transport.ts:12

Базовый URL API.

---

fetch

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

Defined in: realtime/transport.ts:14

Реализация fetch.

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>

---

getToken

getToken: () => Promise<string | null>;

Defined in: realtime/transport.ts:21

Текущий токен доступа.

Returns

Promise<string | null>

---

onEvent

onEvent: (event) => void;

Defined in: realtime/transport.ts:25

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

Parameters

event

TransportEvent

Returns

void

---

onOpen

onOpen: () => void;

Defined in: realtime/transport.ts:29

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

Returns

void

---

onParseError

onParseError: (error, raw) => void;

Defined in: realtime/transport.ts:27

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

Parameters

error

unknown

raw

string

Returns

void

---

signal

signal: AbortSignal;

Defined in: realtime/transport.ts:23

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