import { async } from '../scheduler/async'; import { isDate } from '../util/isDate'; import { Operator } from '../Operator'; import { Subscriber } from '../Subscriber'; import { Subscription } from '../Subscription'; import { Notification } from '../Notification'; import { Observable } from '../Observable'; import { MonoTypeOperatorFunction, PartialObserver, SchedulerAction, SchedulerLike, TeardownLogic } from '../types'; /** * 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> * *  * * 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. * * ## Examples * Delay each click by one second * ```ts * import { fromEvent } from 'rxjs'; * import { delay } from 'rxjs/operators'; * * const clicks = fromEvent(document, 'click'); * const delayedClicks = clicks.pipe(delay(1000)); // each click emitted after 1 second * delayedClicks.subscribe(x => console.log(x)); * ``` * * Delay all clicks until a future date happens * ```ts * import { fromEvent } from 'rxjs'; * import { delay } from 'rxjs/operators'; * * const clicks = fromEvent(document, 'click'); * const date = new Date('March 15, 2050 12:00:00'); // in the future * const delayedClicks = clicks.pipe(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 {SchedulerLike} [scheduler=async] The {@link SchedulerLike} 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 function delay<T>(delay: number|Date, scheduler: SchedulerLike = async): MonoTypeOperatorFunction<T> { const absoluteDelay = isDate(delay); const delayFor = absoluteDelay ? (+delay - scheduler.now()) : Math.abs(<number>delay); return (source: Observable<T>) => source.lift(new DelayOperator(delayFor, scheduler)); } class DelayOperator<T> implements Operator<T, T> { constructor(private delay: number, private scheduler: SchedulerLike) { } call(subscriber: Subscriber<T>, source: any): TeardownLogic { return source.subscribe(new DelaySubscriber(subscriber, this.delay, this.scheduler)); } } interface DelayState<T> { source: DelaySubscriber<T>; destination: PartialObserver<T>; scheduler: SchedulerLike; } /** * We need this JSDoc comment for affecting ESDoc. * @ignore * @extends {Ignored} */ class DelaySubscriber<T> extends Subscriber<T> { private queue: Array<DelayMessage<T>> = []; private active: boolean = false; private errored: boolean = false; private static dispatch<T>(this: SchedulerAction<DelayState<T>>, state: DelayState<T>): void { const source = state.source; const queue = source.queue; const scheduler = state.scheduler; const destination = state.destination; while (queue.length > 0 && (queue[0].time - scheduler.now()) <= 0) { queue.shift().notification.observe(destination); } if (queue.length > 0) { const delay = Math.max(0, queue[0].time - scheduler.now()); this.schedule(state, delay); } else { this.unsubscribe(); source.active = false; } } constructor(destination: Subscriber<T>, private delay: number, private scheduler: SchedulerLike) { super(destination); } private _schedule(scheduler: SchedulerLike): void { this.active = true; const destination = this.destination as Subscription; destination.add(scheduler.schedule<DelayState<T>>(DelaySubscriber.dispatch, this.delay, { source: this, destination: this.destination, scheduler: scheduler })); } private scheduleNotification(notification: Notification<T>): void { if (this.errored === true) { return; } const scheduler = this.scheduler; const message = new DelayMessage(scheduler.now() + this.delay, notification); this.queue.push(message); if (this.active === false) { this._schedule(scheduler); } } protected _next(value: T) { this.scheduleNotification(Notification.createNext(value)); } protected _error(err: any) { this.errored = true; this.queue = []; this.destination.error(err); this.unsubscribe(); } protected _complete() { this.scheduleNotification(Notification.createComplete()); this.unsubscribe(); } } class DelayMessage<T> { constructor(public readonly time: number, public readonly notification: Notification<T>) { } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
audit.ts | File | 4.14 KB | 0644 |
|
auditTime.ts | File | 2.38 KB | 0644 |
|
buffer.ts | File | 2.54 KB | 0644 |
|
bufferCount.ts | File | 4.46 KB | 0644 |
|
bufferTime.ts | File | 8.51 KB | 0644 |
|
bufferToggle.ts | File | 5.6 KB | 0644 |
|
bufferWhen.ts | File | 3.89 KB | 0644 |
|
catchError.ts | File | 4.72 KB | 0644 |
|
combineAll.ts | File | 2.44 KB | 0644 |
|
combineLatest.ts | File | 4.32 KB | 0644 |
|
concat.ts | File | 2.18 KB | 0644 |
|
concatAll.ts | File | 2.26 KB | 0644 |
|
concatMap.ts | File | 3.4 KB | 0644 |
|
concatMapTo.ts | File | 3.05 KB | 0644 |
|
count.ts | File | 3.78 KB | 0644 |
|
debounce.ts | File | 4.88 KB | 0644 |
|
debounceTime.ts | File | 4.54 KB | 0644 |
|
defaultIfEmpty.ts | File | 2.69 KB | 0644 |
|
delay.ts | File | 5.09 KB | 0644 |
|
delayWhen.ts | File | 7.7 KB | 0644 |
|
dematerialize.ts | File | 2.58 KB | 0644 |
|
distinct.ts | File | 4.22 KB | 0644 |
|
distinctUntilChanged.ts | File | 3.76 KB | 0644 |
|
distinctUntilKeyChanged.ts | File | 2.79 KB | 0644 |
|
elementAt.ts | File | 2.56 KB | 0644 |
|
endWith.ts | File | 4.06 KB | 0644 |
|
every.ts | File | 2.54 KB | 0644 |
|
exhaust.ts | File | 3.2 KB | 0644 |
|
exhaustMap.ts | File | 5.64 KB | 0644 |
|
expand.ts | File | 6.18 KB | 0644 |
|
filter.ts | File | 3.69 KB | 0644 |
|
finalize.ts | File | 1.3 KB | 0644 |
|
find.ts | File | 3.81 KB | 0644 |
|
findIndex.ts | File | 1.86 KB | 0644 |
|
first.ts | File | 3.36 KB | 0644 |
|
groupBy.ts | File | 9.95 KB | 0644 |
|
ignoreElements.ts | File | 1.49 KB | 0644 |
|
index.ts | File | 4.02 KB | 0644 |
|
isEmpty.ts | File | 2.67 KB | 0644 |
|
last.ts | File | 2.36 KB | 0644 |
|
map.ts | File | 3.04 KB | 0644 |
|
mapTo.ts | File | 1.9 KB | 0644 |
|
materialize.ts | File | 3.25 KB | 0644 |
|
max.ts | File | 1.54 KB | 0644 |
|
merge.ts | File | 3.59 KB | 0644 |
|
mergeAll.ts | File | 2.43 KB | 0644 |
|
mergeMap.ts | File | 6.28 KB | 0644 |
|
mergeMapTo.ts | File | 2.56 KB | 0644 |
|
mergeScan.ts | File | 4.65 KB | 0644 |
|
min.ts | File | 1.54 KB | 0644 |
|
multicast.ts | File | 3.46 KB | 0644 |
|
observeOn.ts | File | 5.17 KB | 0644 |
|
onErrorResumeNext.ts | File | 8.18 KB | 0644 |
|
pairwise.ts | File | 2.43 KB | 0644 |
|
partition.ts | File | 2.68 KB | 0644 |
|
pluck.ts | File | 3.07 KB | 0644 |
|
publish.ts | File | 2.51 KB | 0644 |
|
publishBehavior.ts | File | 589 B | 0644 |
|
publishLast.ts | File | 2.06 KB | 0644 |
|
publishReplay.ts | File | 1.47 KB | 0644 |
|
race.ts | File | 1.85 KB | 0644 |
|
reduce.ts | File | 3.71 KB | 0644 |
|
refCount.ts | File | 5 KB | 0644 |
|
repeat.ts | File | 3.03 KB | 0644 |
|
repeatWhen.ts | File | 4.15 KB | 0644 |
|
retry.ts | File | 2.74 KB | 0644 |
|
retryWhen.ts | File | 3.45 KB | 0644 |
|
sample.ts | File | 2.78 KB | 0644 |
|
sampleTime.ts | File | 3.18 KB | 0644 |
|
scan.ts | File | 4.13 KB | 0644 |
|
sequenceEqual.ts | File | 5.16 KB | 0644 |
|
share.ts | File | 1.02 KB | 0644 |
|
shareReplay.ts | File | 4.19 KB | 0644 |
|
single.ts | File | 3.79 KB | 0644 |
|
skip.ts | File | 1.27 KB | 0644 |
|
skipLast.ts | File | 2.81 KB | 0644 |
|
skipUntil.ts | File | 3.81 KB | 0644 |
|
skipWhile.ts | File | 1.95 KB | 0644 |
|
startWith.ts | File | 4.35 KB | 0644 |
|
subscribeOn.ts | File | 2.56 KB | 0644 |
|
switchAll.ts | File | 1.99 KB | 0644 |
|
switchMap.ts | File | 6.04 KB | 0644 |
|
switchMapTo.ts | File | 2.56 KB | 0644 |
|
take.ts | File | 2.74 KB | 0644 |
|
takeLast.ts | File | 3.44 KB | 0644 |
|
takeUntil.ts | File | 2.79 KB | 0644 |
|
takeWhile.ts | File | 3.87 KB | 0644 |
|
tap.ts | File | 5.33 KB | 0644 |
|
throttle.ts | File | 4.83 KB | 0644 |
|
throttleTime.ts | File | 5.83 KB | 0644 |
|
throwIfEmpty.ts | File | 2.19 KB | 0644 |
|
timeInterval.ts | File | 2.49 KB | 0644 |
|
timeout.ts | File | 4.07 KB | 0644 |
|
timeoutWith.ts | File | 6.13 KB | 0644 |
|
timestamp.ts | File | 1.67 KB | 0644 |
|
toArray.ts | File | 1.12 KB | 0644 |
|
window.ts | File | 3.72 KB | 0644 |
|
windowCount.ts | File | 4.82 KB | 0644 |
|
windowTime.ts | File | 9.9 KB | 0644 |
|
windowToggle.ts | File | 6.2 KB | 0644 |
|
windowWhen.ts | File | 4.57 KB | 0644 |
|
withLatestFrom.ts | File | 7.72 KB | 0644 |
|
zip.ts | File | 3.35 KB | 0644 |
|
zipAll.ts | File | 653 B | 0644 |
|