@types/rx-lite-backpressure/index.d.ts

TypeScript definitions for rx-lite-backpressure

/// <reference types="rx-lite" />

declare namespace Rx {
    interface Observable<T> {
        /**
         * Pauses the underlying observable sequence based upon the observable sequence which yields true/false.
         * @example
         * var pauser = new Rx.Subject();
         * var source = Rx.Observable.interval(100).pausable(pauser);
         * @param pauser The observable sequence used to pause the underlying sequence.
         * @returns The observable sequence which is paused based upon the pauser.
         */
        pausable(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.
         * @example
         * var pauser = new Rx.Subject();
         * var source = Rx.Observable.interval(100).pausableBuffered(pauser);
         * @param pauser The observable sequence used to pause the underlying sequence.
         * @returns The observable sequence which is paused based upon the pauser.
         */
        pausableBuffered(pauser?: Observable<boolean>): PausableObservable<T>;

        /**
         * Attaches a controller to the observable sequence with the ability to queue.
         * @example
         * var source = Rx.Observable.interval(100).controlled();
         * source.request(3); // Reads 3 values
         */
        controlled(enableQueue?: boolean): ControlledObservable<T>;
    }

    interface ControlledObservable<T> extends Observable<T> {
        request(numberOfItems?: number): IDisposable;
    }

    interface PausableObservable<T> extends Observable<T> {
        pause(): void;
        resume(): void;
    }
}

declare module "rx-lite-backpressure" {
    export = Rx;
}