abort-controller-x-rxjs

Abortable helpers for RxJS.

This is a companion package of abort-controller-x.

• Installation
• API
  • defer
  • firstValueFrom
  • lastValueFrom
  • fromAsyncGenerator

Installation

yarn add abort-controller-x-rxjs

API

defer

1function defer<R extends ObservableInput<any> | void>(
2  observableFactory: (signal: AbortSignal) => R,
3): Observable<ObservedValueOf<R>>;

Like original defer from RxJS, but aborts passed function when unsubscribed.

firstValueFrom

1function firstValueFrom<T, D>(
2  signal: AbortSignal,
3  source: Observable<T>,
4  config: FirstValueFromConfig<D>,
5): Promise<T | D>;
6function firstValueFrom<T>(
7  signal: AbortSignal,
8  source: Observable<T>,
9): Promise<T>;
10
11interface FirstValueFromConfig<T> {
12  defaultValue: T;
13}

Like original firstValueFrom from RxJS, but accepts AbortSignal. When that signal is aborted, unsubscribes from the observable and throws AbortError.

lastValueFrom

1function lastValueFrom<T, D>(
2  signal: AbortSignal,
3  source: Observable<T>,
4  config: LastValueFromConfig<D>,
5): Promise<T | D>;
6function lastValueFrom<T>(
7  signal: AbortSignal,
8  source: Observable<T>,
9): Promise<T>;
10
11interface LastValueFromConfig<T> {
12  defaultValue: T;
13}

Like original lastValueFrom from RxJS, but accepts AbortSignal. When that signal is aborted, unsubscribes from the observable and throws AbortError.

fromAsyncGenerator

1function fromAsyncGenerator<T>(
2  fn: (signal: AbortSignal) => AsyncIterable<T>,
3): Observable<T>;

Turns abortable async generator to observable.