itd-api / EventChannelDeps

Interface: EventChannelDeps<U, C, O>

Defined in: events/engine.ts:75

Что движок получает от домена.

Type Parameters

U

U

нормализованное обновление домена

C

C extends EventContext<U, unknown, O>

контекст обработки, который домен собирает вокруг обновления

O

O = unknown

Properties

bufferFrame?

optional bufferFrame?: (event) => boolean;

Defined in: events/engine.ts:112

Выбирает кадры, которые нужно накопить до завершения подготовки. По умолчанию все.

Parameters

event

EventTransportFrame

Returns

boolean

---

clock?

optional clock?: ItdClock;

Defined in: events/engine.ts:77

---

coalesceKey?

optional coalesceKey?: (update) => PropertyKey | undefined;

Defined in: events/engine.ts:96

Ключ коалесцирования: ожидающее обновление с тем же ключом заменяется новым. undefined — обновление не коалесцируется.

Parameters

update

U

Returns

PropertyKey | undefined

---

connectGuard?

optional connectGuard?: () => void;

Defined in: events/engine.ts:102

Проверяет, можно ли запустить канал.

Returns

void

---

connection

connection: ClientConnection;

Defined in: events/engine.ts:76

---

createContext

createContext: (update, raw, origin) => C;

Defined in: events/engine.ts:98

Собирает контекст. Точка, куда домен добавляет свои поля и действия.

Parameters

update

U

raw

EventTransportFrame | undefined

origin

O

Returns

C

---

deliver

deliver: (update) => void;

Defined in: events/engine.ts:100

Доставляет обновление доменным подписчикам после цепочки обработчиков.

Parameters

update

U

Returns

void

---

handleFrame?

optional handleFrame?: (event) => boolean;

Defined in: events/engine.ts:89

Доменная обработка сырого кадра до нормализации. true — кадр поглощён и дальше не идёт. Нужна там, где кадр не является обновлением: у уведомлений так приходит connected.

Parameters

event

EventTransportFrame

Returns

boolean

---

initializationRequired?

optional initializationRequired?: boolean;

Defined in: events/engine.ts:110

Ошибка подготовки отклоняет первый connect().

---

initialize?

optional initialize?: (reason, session) => Promise<void>;

Defined in: events/engine.ts:104

Подготовка одной попытки соединения.

Parameters

reason

EventSyncReason

session

EventSession<U, O>

Returns

Promise<void>

---

logger?

optional logger?: Logger;

Defined in: events/engine.ts:78

---

openBeforeInitialize?

optional openBeforeInitialize?: boolean;

Defined in: events/engine.ts:108

Открывает транспорт до подготовки и накапливает выбранные кадры до её завершения.

---

readUpdate

readUpdate: (event) => U | undefined;

Defined in: events/engine.ts:91

Превращает кадр в доменное обновление; undefined — кадр игнорируется.

Parameters

event

EventTransportFrame

Returns

U | undefined

---

streamOrigin

streamOrigin: O;

Defined in: events/engine.ts:82

Источник, который домен назначает нормализованным кадрам транспорта.

---

transport

transport: EventTransport;

Defined in: events/engine.ts:80