fromDelay - API reference

API reference › @evolu/common › Schedule › fromDelay

function fromDelay(
  delay: Duration,
): Schedule<
  number &
    Brand<"NonNaN"> &
    Brand<"Finite"> &
    Brand<"Int"> &
    Brand<"NonNegative"> &
    Brand<"LessThan281474976710655"> &
    Brand<"Millis">
>;

Defined in: packages/common/src/Schedule.ts:541

A schedule that runs once with a single delay.

Convenience for take(1)(spaced(delay)). Useful for simple one-shot delays.

Scheduling one delayed recurrence

import {
  assertErr,
  assertOk,
  done,
  fromDelay,
  testCreateDeps,
} from "@evolu/common";

// Wait one second, then stop.
const step = fromDelay("1s")(testCreateDeps());
assertOk(step(undefined), [1000, 1000]);
assertErr(step(undefined), done());