Documentation - v20.0.0-dev
    Preparing search index...

    A typed event channel:

    const onSave = new Signal<(id: string, force: boolean) => void>();
    const connection = onSave.connect((id, force) => { ... });
    onSave.emit('abc', true);
    connection.disconnect();

    The listeners are isolated: one that throws (or whose promise rejects) never stops the others, nor makes emit throw; its error goes to the signal's error handler (a console error by default). The emitter is safe whatever its listeners do. An emit calls the listeners connected when it starts, those disconnected meanwhile left out: it allocates nothing, some signals being emitted every frame.

    Type Parameters

    Index

    Constructors

    Accessors

    • get listenerCount(): number

      Listeners connected.

      Returns number

    Methods

    • Disconnects every connection made with this callback; false when there was none.

      Parameters

      Returns boolean

    • Disconnects every listener: for the signal's owner, when disposed.

      Returns void

    • Calls every enabled listener, in the order they were connected. Never throws.

      Parameters

      Returns void

    • Whether a listener is connected.

      Returns boolean