Class Emitter<TEvent>`Abstract`

An event emitter

Type Parameters

TEvent

Hierarchy (View Summary)

Emitter
- ObserverEmitter

Implements

Observable<TEvent>

Index

Constructors

Methods

filter indexed map next observe unobserve from

Constructors

constructor

new Emitter<TEvent>(): Emitter<TEvent>
Type Parameters
- TEvent
Returns Emitter<TEvent>

Methods

filter

filter(f: (event: TEvent) => boolean): Emitter<TEvent>
Filter events emitted by this emitter.
Parameters
- f: (event: TEvent) => boolean
  The predicate to apply to each event.
Returns Emitter<TEvent>
An emitter than only emits events emitted by this emitter for which f returns true.
- Defined in src/emitter.tsx:100

indexed

indexed(): Emitter<number>
Creates an emitter that counts events emitted by this emitter.

Returns Emitter<number>
An emitter that emits the index, starting at zero, of every event emitted by this emitter.
- Defined in src/emitter.tsx:110
indexed<TOut>(f: (event: TEvent, index: number) => TOut): Emitter<TOut>
Apply a function to all events and their index (starting at zero) emitted by this emitter.
Type Parameters
- TOut
Parameters
- f: (event: TEvent, index: number) => TOut
Returns Emitter<TOut>
An emitter that applies the function f to all events emitted by this emitter.
- Defined in src/emitter.tsx:118

map

map<TOut>(f: (event: TEvent) => TOut): Emitter<TOut>
Apply a function to all events emitted by this emitter.
Type Parameters
- TOut
Parameters
- f: (event: TEvent) => TOut
  The function to apply to events.
Returns Emitter<TOut>
An emitter that applies the function f to all events emitted by this emitter.
- Defined in src/emitter.tsx:89

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.
- Defined in src/emitter.tsx:134

`Abstract`observe

observe(observer: Observer<TEvent>): () => void
Attach an observer.
Parameters
- observer: Observer<TEvent>
  The observer function to attach.
Returns () => void
A function that can be called to detach the observer. Alternatively unobserve can be called.
Implementation of Observable.observe
- Defined in src/emitter.tsx:79

`Abstract`unobserve

unobserve(observer: Observer<TEvent>): void
Detach an observer.
Parameters
- observer: Observer<TEvent>
  The observer function to detach.
Returns void
Implementation of Observable.unobserve
- Defined in src/emitter.tsx:80

`Static`from

from<TEvent>(observable: Observable<TEvent>): Emitter<TEvent>
Create an emitter from another observable (cell or emitter). The resulting emitter emits an even whenever the input observable emits an event.
Type Parameters
- TEvent
Parameters
- observable: Observable<TEvent>
  The observable to wrap.
Returns Emitter<TEvent>
An emitter that emits the same events as observable.
- Defined in src/emitter.tsx:151