Skip to main content

Function: toTimeoutMilliseconds()

toTimeoutMilliseconds(value: number): TimeoutMilliseconds

Defined in: shared/types/units.ts:87

Brands a validated number as a TimeoutMilliseconds value.

Parameters​

value​

number

Millisecond duration to brand. Must be finite and non-negative.

Returns​

TimeoutMilliseconds

The branded timeout duration.

Throws​

RangeError When the value is negative or not finite.