Skip to main content
Module

x/rxjs/mod.ts>delay

Deno port of RXJS
Latest
function delay
import { delay } from "https://deno.land/x/rxjs@v1.0.2/mod.ts";

Delays the emission of items from the source Observable by a given timeout or until a given Date.

Time shifts each item by some specified amount of milliseconds.

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

import { fromEvent, delay } from 'rxjs';

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

import { fromEvent, delay } from 'rxjs';

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));

Parameters

due: number | Date

The delay duration in milliseconds (a number) or a Date until which the emission of the source items is delayed.

optional
scheduler: SchedulerLike = [UNSUPPORTED]

Returns

A function that returns an Observable that delays the emissions of the source Observable by the specified timeout or Date.