JSPM

@types/rx-lite-backpressure

4.0.5
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 32221
  • Score
    100M100P100Q166317F
  • License MIT

TypeScript definitions for rx-lite-backpressure

Package Exports

    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 (@types/rx-lite-backpressure) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Installation

    npm install --save @types/rx-lite-backpressure

    Summary

    This package contains type definitions for rx-lite-backpressure (https://github.com/Reactive-Extensions/RxJS).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rx-lite-backpressure.

    index.d.ts

    /// <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;
    }
    

    Additional Details

    • Last updated: Tue, 07 Nov 2023 15:11:36 GMT
    • Dependencies: @types/rx-lite

    Credits

    These definitions were written by Igor Oleinikov.