49 lines
1.9 KiB
TypeScript
49 lines
1.9 KiB
TypeScript
|
import { IScheduler } from '../Scheduler';
|
||
|
|
import { Observable } from '../Observable';
|
||
|
|
import { TeardownLogic } from '../Subscription';
|
||
|
|
import { Subscriber } from '../Subscriber';
|
||
|
|
/**
|
||
|
|
* We need this JSDoc comment for affecting ESDoc.
|
||
|
|
* @extends {Ignored}
|
||
|
|
* @hide true
|
||
|
|
*/
|
||
|
|
export declare class RangeObservable extends Observable<number> {
|
||
|
|
/**
|
||
|
|
* Creates an Observable that emits a sequence of numbers within a specified
|
||
|
|
* range.
|
||
|
|
*
|
||
|
|
* <span class="informal">Emits a sequence of numbers in a range.</span>
|
||
|
|
*
|
||
|
|
* <img src="./img/range.png" width="100%">
|
||
|
|
*
|
||
|
|
* `range` operator emits a range of sequential integers, in order, where you
|
||
|
|
* select the `start` of the range and its `length`. By default, uses no
|
||
|
|
* IScheduler and just delivers the notifications synchronously, but may use
|
||
|
|
* an optional IScheduler to regulate those deliveries.
|
||
|
|
*
|
||
|
|
* @example <caption>Emits the numbers 1 to 10</caption>
|
||
|
|
* var numbers = Rx.Observable.range(1, 10);
|
||
|
|
* numbers.subscribe(x => console.log(x));
|
||
|
|
*
|
||
|
|
* @see {@link timer}
|
||
|
|
* @see {@link interval}
|
||
|
|
*
|
||
|
|
* @param {number} [start=0] The value of the first integer in the sequence.
|
||
|
|
* @param {number} [count=0] The number of sequential integers to generate.
|
||
|
|
* @param {Scheduler} [scheduler] A {@link IScheduler} to use for scheduling
|
||
|
|
* the emissions of the notifications.
|
||
|
|
* @return {Observable} An Observable of numbers that emits a finite range of
|
||
|
|
* sequential integers.
|
||
|
|
* @static true
|
||
|
|
* @name range
|
||
|
|
* @owner Observable
|
||
|
|
*/
|
||
|
|
static create(start?: number, count?: number, scheduler?: IScheduler): Observable<number>;
|
||
|
|
static dispatch(state: any): void;
|
||
|
|
private start;
|
||
|
|
private _count;
|
||
|
|
private scheduler;
|
||
|
|
constructor(start: number, count: number, scheduler?: IScheduler);
|
||
|
|
/** @deprecated internal use only */ _subscribe(subscriber: Subscriber<number>): TeardownLogic;
|
||
|
|
}
|