timeout | /src/timeout.ts | delayed@2.0.2

function timeout

import { timeout } from "https://deno.land/x/delayed@2.0.2/src/timeout.ts";

timeout<TArgs extends unknown[], TReturn = unknown>(

delay: ms,

unnamed 2?: { signal?: AbortSignal; },

...args: TArgs,

): Promise<TReturn>

Execute the callback at least after the specified delay

Examples

const { status } = await timeout(() => fetch('https://deno.land'), 500)
//wait 500ms and then status === 200

timeout(console.log, 1000, {}, 'delayed', 1000, 's')
//print the message "delayed 1000 s" after 1s

const ac = new AbortController()
timeout(exit, 1000, ac, 1)
ac.abort()
//abort timeout before executing "exit" with arg "1"

TArgs extends unknown[]

optional

TReturn = unknown

delay: ms

optional

unnamed 2: { signal?: AbortSignal; } = [UNSUPPORTED]

...args: TArgs

Promise<TReturn>

A promise that resolves to the value returned by the callback.