You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
42 lines
1.9 KiB
42 lines
1.9 KiB
import { IScheduler } from '../Scheduler'; |
|
import { Observable } from '../Observable'; |
|
/** |
|
* Delays the emission of items from the source Observable by a given timeout or |
|
* until a given Date. |
|
* |
|
* <span class="informal">Time shifts each item by some specified amount of |
|
* milliseconds.</span> |
|
* |
|
* <img src="./img/delay.png" width="100%"> |
|
* |
|
* If the delay argument is a Number, this operator time shifts the source |
|
* Observable by that amount of time expressed in milliseconds. The relative |
|
* time intervals between the values are preserved. |
|
* |
|
* If the delay argument is a Date, this operator time shifts the start of the |
|
* Observable execution until the given date occurs. |
|
* |
|
* @example <caption>Delay each click by one second</caption> |
|
* var clicks = Rx.Observable.fromEvent(document, 'click'); |
|
* var delayedClicks = clicks.delay(1000); // each click emitted after 1 second |
|
* delayedClicks.subscribe(x => console.log(x)); |
|
* |
|
* @example <caption>Delay all clicks until a future date happens</caption> |
|
* var clicks = Rx.Observable.fromEvent(document, 'click'); |
|
* var date = new Date('March 15, 2050 12:00:00'); // in the future |
|
* var delayedClicks = clicks.delay(date); // click emitted only after that date |
|
* delayedClicks.subscribe(x => console.log(x)); |
|
* |
|
* @see {@link debounceTime} |
|
* @see {@link delayWhen} |
|
* |
|
* @param {number|Date} delay The delay duration in milliseconds (a `number`) or |
|
* a `Date` until which the emission of the source items is delayed. |
|
* @param {Scheduler} [scheduler=async] The IScheduler to use for |
|
* managing the timers that handle the time-shift for each item. |
|
* @return {Observable} An Observable that delays the emissions of the source |
|
* Observable by the specified timeout or Date. |
|
* @method delay |
|
* @owner Observable |
|
*/ |
|
export declare function delay<T>(this: Observable<T>, delay: number | Date, scheduler?: IScheduler): Observable<T>;
|
|
|