delay.md

Rx.Observable.prototype.delay(dueTime, [scheduler])

Ⓢ

Time shifts the observable sequence by dueTime. The relative time intervals between the values are preserved.

Arguments

1. dueTime (Date | Number): Absolute (specified as a Date object) or relative time (specified as an integer denoting milliseconds) by which to shift the observable sequence.
2. [scheduler=Rx.Scheduler.timeout] (Scheduler): Scheduler to run the delay timers on. If not specified, the timeout scheduler is used.

Returns

(Observable): Time-shifted sequence.

Example

/* Using an absolute time to delay by a second */
var source = Rx.Observable.range(0, 3)
    .delay(new Date(Date.now() + 1000));

var subscription = source.subscribe(
    function (x) {
        console.log('Next: ' + x.toString());
    },
    function (err) {
        console.log('Error: ' + err);
    },
    function () {
        console.log('Completed');
    });

// => Next: 0
// => Next: 1
// => Next: 2
// => Completed

/* Using an relatove time to delay by a second */
var source = Rx.Observable.range(0, 3)
    .delay(1000);

var subscription = source.subscribe(
    function (x) {
        console.log('Next: ' + x.toString());
    },
    function (err) {
        console.log('Error: ' + err);
    },
    function () {
        console.log('Completed');
    });

// => Next: 0
// => Next: 1
// => Next: 2
// => Completed

Location

File:

• /src/core/linq/observable/delay.js

Dist:

• rx.all.js
• rx.all.compat.js
• rx.time.js

Prerequisites:

• rx.time.js
  • rx.js | rx.compat.js
• rx.lite.js | rx.lite.compat.js

NPM Packages:

• rx

NuGet Packages:

• RxJS-All
• RxJS-Time
• RxJS-Lite

Unit Tests:

• /tests/observable/delay.js