Class PubSub<T>

Publish–subscribe pattern implementation that guarantees the delivery of published messages even if any of listeners would throw an error.

Type Parameters

  • T = void

    The published message.

Constructors

constructor

Accessors

listenerCount

Methods

publish subscribe unsubscribe unsubscribeAll waitFor

Constructors

constructor

Accessors

listenerCount

  • get listenerCount(): number

  • The number of subscribed listeners.

    Returns number

Methods

publish

  • publish(message): void

  • Synchronously invokes listeners with the published message.

    Parameters

    • message: T

      The published message.

    Returns void

subscribe

  • subscribe(listener): (() => void)

  • Adds a listener that would receive all messages published via publish.

    Parameters

    • listener: ((message: T) => any)

      The callback.

        • (message): any

        • Parameters

          • message: T

          Returns any

    Returns (() => void)

    The callback that unsubscribes the listener.

      • (): void

      • Returns void

unsubscribe

  • unsubscribe(listener): void

  • Unsubscribes a listener.

    Parameters

    • listener: ((message: T) => any)

      The callback that was previously subscribed.

        • (message): any

        • Parameters

          • message: T

          Returns any

    Returns void

unsubscribeAll

  • unsubscribeAll(): void

  • Unsubscribes all listeners.

    Returns void

waitFor

  • waitFor<R>(predicate): AbortablePromise<R>

  • Waits for a message that satisfies the given predicate to be published and resolves with that message.

    Type Parameters

    • R

      A subtype of T that the predicate function identifies as satisfying the condition.

    Parameters

    • predicate: ((message: T) => message is R)

      A function that takes the message as a parameter and returns true if the message satisfies the condition, otherwise false.

        • (message): message is R

        • Parameters

          • message: T

          Returns message is R

    Returns AbortablePromise<R>

    An AbortablePromise that resolves with the published message that satisfies the predicate.

  • waitFor(predicate): AbortablePromise<T>

  • Waits for a message that satisfies the given predicate to be published and resolves with that message.

    Parameters

    • predicate: ((message: T) => boolean)

      A function that takes the message as a parameter and returns true if the message satisfies the condition, otherwise false.

        • (message): boolean

        • Parameters

          • message: T

          Returns boolean

    Returns AbortablePromise<T>

    An AbortablePromise that resolves with the published message that satisfies the predicate.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods