async.Function.timeout

@zenstone/ts-utils / async / timeout

Function: timeout()

timeout<F>(fn, ms): (...args) => Promise<Awaited<ReturnType<F>>>

Defined in: src/async/index.ts:231

包装函数，添加超时控制

返回的函数保持原函数的参数签名，返回值统一为 Promise。 如果执行超过指定时间，将抛出 TimeoutError。

Type Parameters

F

F extends AnyFn

Parameters

fn

F

要包装的函数（同步或异步）

ms

number

超时毫秒数

Returns

包装后的函数

(...args) => Promise<Awaited<ReturnType<F>>>

Example

const fetchWithTimeout = timeout(
  (url: string) => fetch(url).then(r => r.json()),
  5000,
);

const data = await fetchWithTimeout('/api/data');