Class MutEmitter<TEvent>

A mutable emitter.

Type Parameters

  • TEvent

Hierarchy (view full)

Constructors

constructor

Accessors

observed

Methods

asEmitter destroy emit emitEvent filter indexed init map next observe unobserve from

Constructors

constructor

Accessors

Protected observed

  • get observed(): boolean

  • Returns boolean

    True if this emitter has any observers, false otherwise.

Methods

asEmitter

Protected destroy

emit

  • emit(event): void

  • Emit an event to all observers of this emitter.

    Parameters

    • event: TEvent

      The event to emit.

    Returns void

Protected emitEvent

filter

  • filter(f): Emitter<TEvent>

  • Filter events emitted by this emitter.

    Parameters

    • f: ((event) => boolean)

      The predicate to apply to each event.

        • (event): boolean

        • Parameters

          Returns boolean

    Returns Emitter<TEvent>

    An emitter than only emits events emitted by this emitter for which f returns true.

indexed

Protected init

map

next

  • next(): Promise<TEvent>

  • Create a promise that resolves the next time an event is emitted by this emitter.

    Returns Promise<TEvent>

    A promise that resolves to the next event emitted by this emitter.

observe

  • observe(observer): (() => void)

  • Attach an observer.

    Parameters

    Returns (() => void)

    A function that can be called to detach the observer. Alternatively unobserve can be called.

      • (): void

      • Returns void

unobserve

Static from

Settings

Member Visibility

Theme

On This Page

constructorobservedasEmitterdestroyemitemitEventfilterindexedinitmapnextobserveunobservefrom