abort-controller-x-rxjs [![npm version][npm-image]][npm-url]

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

$3

`ts
function defer | void>(
observableFactory: (signal: AbortSignal) => R,
): Observable>;
`

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

$3

`ts
function firstValueFrom(
signal: AbortSignal,
source: Observable,
config: FirstValueFromConfig,
): Promise;
function firstValueFrom(
signal: AbortSignal,
source: Observable,
): Promise;

interface FirstValueFromConfig {
defaultValue: T;
}
`

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

$3

`ts
function lastValueFrom(
signal: AbortSignal,
source: Observable,
config: LastValueFromConfig,
): Promise;
function lastValueFrom(
signal: AbortSignal,
source: Observable,
): Promise;

interface LastValueFromConfig {
defaultValue: T;
}
`

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

$3

`ts
function fromAsyncGenerator(
fn: (signal: AbortSignal) => AsyncIterable,
): Observable;
``

Turns abortable async generator to observable.

[npm-image]: https://badge.fury.io/js/abort-controller-x-rxjs.svg
[npm-url]: https://badge.fury.io/js/abort-controller-x-rxjs