Iskra API Reference
    Preparing search index...

    Interface SocketContext<TPayload, TData>

    What an app.on() handler receives; payload is the emitted value.

    interface SocketContext<
        TPayload = unknown,
        TData extends SocketData = SocketData,
    > {
        app: App;
        logger: Logger;
        payload: TPayload;
        socket: ServerWebSocket<TData>;
        broadcast(topic: string, data: unknown): void;
        join(room: string): void;
        leave(room: string): void;
        reply(data: unknown): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    app logger payload socket
    broadcast join leave reply
    app: App
    logger: Logger
    payload: TPayload
    socket: ServerWebSocket<TData>

    • Publish to all sockets subscribed to topic (e.g. 'global'). The frame is wrapped in the driver envelope: {event: topic, payload: data}. Subject to the driver's canPublish authorization hook.

      Parameters

      • topic: string
      • data: unknown

      Returns void

    • Subscribe this socket to a named room.

      Parameters

      • room: string

      Returns void

    • Unsubscribe this socket from a named room.

      Parameters

      • room: string

      Returns void

    • Send a message back to this socket only.

      Parameters

      • data: unknown

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods