RangeObservable.d.ts 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. import { IScheduler } from '../Scheduler';
  2. import { Observable } from '../Observable';
  3. import { TeardownLogic } from '../Subscription';
  4. import { Subscriber } from '../Subscriber';
  5. /**
  6. * We need this JSDoc comment for affecting ESDoc.
  7. * @extends {Ignored}
  8. * @hide true
  9. */
  10. export declare class RangeObservable extends Observable<number> {
  11. /**
  12. * Creates an Observable that emits a sequence of numbers within a specified
  13. * range.
  14. *
  15. * <span class="informal">Emits a sequence of numbers in a range.</span>
  16. *
  17. * <img src="./img/range.png" width="100%">
  18. *
  19. * `range` operator emits a range of sequential integers, in order, where you
  20. * select the `start` of the range and its `length`. By default, uses no
  21. * IScheduler and just delivers the notifications synchronously, but may use
  22. * an optional IScheduler to regulate those deliveries.
  23. *
  24. * @example <caption>Emits the numbers 1 to 10</caption>
  25. * var numbers = Rx.Observable.range(1, 10);
  26. * numbers.subscribe(x => console.log(x));
  27. *
  28. * @see {@link timer}
  29. * @see {@link interval}
  30. *
  31. * @param {number} [start=0] The value of the first integer in the sequence.
  32. * @param {number} [count=0] The number of sequential integers to generate.
  33. * @param {Scheduler} [scheduler] A {@link IScheduler} to use for scheduling
  34. * the emissions of the notifications.
  35. * @return {Observable} An Observable of numbers that emits a finite range of
  36. * sequential integers.
  37. * @static true
  38. * @name range
  39. * @owner Observable
  40. */
  41. static create(start?: number, count?: number, scheduler?: IScheduler): Observable<number>;
  42. static dispatch(state: any): void;
  43. private start;
  44. private _count;
  45. private scheduler;
  46. constructor(start: number, count: number, scheduler?: IScheduler);
  47. /** @deprecated internal use only */ _subscribe(subscriber: Subscriber<number>): TeardownLogic;
  48. }