@types/rx-lite-backpressure
- Version 4.0.5
- Published
- 6.34 kB
- 1 dependency
- MIT license
Install
npm i @types/rx-lite-backpressure
yarn add @types/rx-lite-backpressure
pnpm add @types/rx-lite-backpressure
Overview
TypeScript definitions for rx-lite-backpressure
Index
Namespaces
namespace Rx
namespace Rx {}
interface ControlledObservable
interface ControlledObservable<T> extends Observable<T> {}
method request
request: (numberOfItems?: number) => IDisposable;
interface Observable
interface Observable<T> {}
method controlled
controlled: (enableQueue?: boolean) => ControlledObservable<T>;
Attaches a controller to the observable sequence with the ability to queue.
Example 1
var source = Rx.Observable.interval(100).controlled(); source.request(3); // Reads 3 values
method pausable
pausable: (pauser?: Observable<boolean>) => PausableObservable<T>;
Pauses the underlying observable sequence based upon the observable sequence which yields true/false.
Parameter pauser
The observable sequence used to pause the underlying sequence.
Returns
The observable sequence which is paused based upon the pauser.
Example 1
var pauser = new Rx.Subject(); var source = Rx.Observable.interval(100).pausable(pauser);
method pausableBuffered
pausableBuffered: (pauser?: Observable<boolean>) => PausableObservable<T>;
Pauses the underlying observable sequence based upon the observable sequence which yields true/false, and yields the values that were buffered while paused.
Parameter pauser
The observable sequence used to pause the underlying sequence.
Returns
The observable sequence which is paused based upon the pauser.
Example 1
var pauser = new Rx.Subject(); var source = Rx.Observable.interval(100).pausableBuffered(pauser);
interface PausableObservable
interface PausableObservable<T> extends Observable<T> {}
namespace rx-lite-backpressure
module 'rx-lite-backpressure' {}
interface ControlledObservable
interface ControlledObservable<T> extends Observable<T> {}
method request
request: (numberOfItems?: number) => IDisposable;
interface Observable
interface Observable<T> {}
method controlled
controlled: (enableQueue?: boolean) => ControlledObservable<T>;
Attaches a controller to the observable sequence with the ability to queue.
Example 1
var source = Rx.Observable.interval(100).controlled(); source.request(3); // Reads 3 values
method pausable
pausable: (pauser?: Observable<boolean>) => PausableObservable<T>;
Pauses the underlying observable sequence based upon the observable sequence which yields true/false.
Parameter pauser
The observable sequence used to pause the underlying sequence.
Returns
The observable sequence which is paused based upon the pauser.
Example 1
var pauser = new Rx.Subject(); var source = Rx.Observable.interval(100).pausable(pauser);
method pausableBuffered
pausableBuffered: (pauser?: Observable<boolean>) => PausableObservable<T>;
Pauses the underlying observable sequence based upon the observable sequence which yields true/false, and yields the values that were buffered while paused.
Parameter pauser
The observable sequence used to pause the underlying sequence.
Returns
The observable sequence which is paused based upon the pauser.
Example 1
var pauser = new Rx.Subject(); var source = Rx.Observable.interval(100).pausableBuffered(pauser);
interface PausableObservable
interface PausableObservable<T> extends Observable<T> {}
Package Files (1)
Dependencies (1)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/rx-lite-backpressure
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/rx-lite-backpressure)
- HTML<a href="https://www.jsdocs.io/package/@types/rx-lite-backpressure"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 1727 ms. - Missing or incorrect documentation? Open an issue for this package.