eve/dist/src/compiled/@workflow/core/sleep.d.ts

Filesystem-first framework for durable backend AI agents that run anywhere.

import type { StringValue } from './_ms.js';
/**
 * Sleep within a workflow for a given duration.
 *
 * This is a built-in runtime function that uses timer events in the event log.
 *
 * @param duration - The duration to sleep for, this is a string in the format
 * of `"1000ms"`, `"1s"`, `"1m"`, `"1h"`, or `"1d"`.
 * @overload
 * @returns A promise that resolves when the sleep is complete.
 */
export declare function sleep(duration: StringValue): Promise<void>;
/**
 * Sleep within a workflow until a specific date.
 *
 * This is a built-in runtime function that uses timer events in the event log.
 *
 * @param date - The date to sleep until, this must be a future date.
 * @overload
 * @returns A promise that resolves when the sleep is complete.
 */
export declare function sleep(date: Date): Promise<void>;
/**
 * Sleep within a workflow for a given duration in milliseconds.
 *
 * This is a built-in runtime function that uses timer events in the event log.
 *
 * @param durationMs - The duration to sleep for in milliseconds.
 * @overload
 * @returns A promise that resolves when the sleep is complete.
 */
export declare function sleep(durationMs: number): Promise<void>;
//# sourceMappingURL=sleep.d.ts.map