API reference › @evolu/common › Time › durationToMillis

Call Signature

function durationToMillis(
  duration:
    | DurationLiteral
    | (number &
        Brand<"NonNaN"> &
        Brand<"Finite"> &
        Brand<"Int"> &
        Brand<"NonNegative"> &
        Brand<"LessThan281474976710655"> &
        Brand<"Millis"> &
        Brand<"Positive">),
): number &
  Brand<"NonNaN"> &
  Brand<"Finite"> &
  Brand<"Int"> &
  Brand<"NonNegative"> &
  Brand<"LessThan281474976710655"> &
  Brand<"Millis"> &
  Brand<"Positive">;

Defined in: packages/common/src/Time.ts:760

Converts a duration to milliseconds.

Accepts either a DurationLiteral (e.g., "5m", "1.5s") or Millis.

Example

import { assertEqual, durationToMillis, Millis } from "@evolu/common";

assertEqual(durationToMillis("1.5s"), 1500);
assertEqual(durationToMillis("5m"), 300000);
assertEqual(durationToMillis("12h"), 43200000);
assertEqual(durationToMillis("1w"), 604800000);
assertEqual(durationToMillis(Millis.orThrow(5000)), 5000);

Call Signature

function durationToMillis(
  duration: Duration,
): number &
  Brand<"NonNaN"> &
  Brand<"Finite"> &
  Brand<"Int"> &
  Brand<"NonNegative"> &
  Brand<"LessThan281474976710655"> &
  Brand<"Millis">;

Defined in: packages/common/src/Time.ts:765

Converts a general Duration, including zero, to milliseconds.

Markdown for LLMs