Package Exports

abort-controller-x-rxjs
abort-controller-x-rxjs/es/index.js
abort-controller-x-rxjs/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (abort-controller-x-rxjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

abort-controller-x-rxjs

Abortable helpers for RxJS.

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

Installation
API

Installation

yarn add abort-controller-x-rxjs

API

`defer`

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

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

`firstValueFrom`

function firstValueFrom<T, D>(
  signal: AbortSignal,
  source: Observable<T>,
  config: FirstValueFromConfig<D>,
): Promise<T | D>;
function firstValueFrom<T>(
  signal: AbortSignal,
  source: Observable<T>,
): Promise<T>;

interface FirstValueFromConfig<T> {
  defaultValue: T;
}

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

`lastValueFrom`

function lastValueFrom<T, D>(
  signal: AbortSignal,
  source: Observable<T>,
  config: LastValueFromConfig<D>,
): Promise<T | D>;
function lastValueFrom<T>(
  signal: AbortSignal,
  source: Observable<T>,
): Promise<T>;

interface LastValueFromConfig<T> {
  defaultValue: T;
}

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

`fromAsyncGenerator`

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

Turns abortable async generator to observable.