Variable event`Const`

event: {
    emit: (
        eventName: string,
        payload?: JsonValue,
        excludeSelf?: boolean,
    ) => Promise<EventEmitResponse>;
    emitTo: (
        eventName: string,
        payload: JsonValue,
        targetWindowId: string,
    ) => Promise<EventEmitToResponse>;
} = ...

event — custom event broadcast / direct delivery namespace.

Type Declaration

emit: (
    eventName: string,
    payload?: JsonValue,
    excludeSelf?: boolean,
) => Promise<EventEmitResponse>

Broadcast an event to every connected window (optionally excluding self). Receivers get { payload, sourceWindowId } under eventName.
emitTo: (
    eventName: string,
    payload: JsonValue,
    targetWindowId: string,
) => Promise<EventEmitToResponse>

Deliver an event to a specific window by id. An id no open window has fails with code: 'NOT_FOUND'.

Variable eventConst

Type Declaration

emit: ( eventName: string, payload?: JsonValue, excludeSelf?: boolean,) => Promise<EventEmitResponse>

emitTo: ( eventName: string, payload: JsonValue, targetWindowId: string,) => Promise<EventEmitToResponse>

Settings

Variable event`Const`

emit: (
eventName: string,
payload?: JsonValue,
excludeSelf?: boolean,
) => Promise<EventEmitResponse>

emitTo: (
eventName: string,
payload: JsonValue,
targetWindowId: string,
) => Promise<EventEmitToResponse>