Skip to main content

Function: safeParseTimeout()

safeParseTimeout(value: unknown, defaultValue: number | TimeoutMilliseconds): TimeoutMilliseconds

Defined in: shared/utils/safeConversions.ts:342

Safely converts a value to a timeout value (positive number) with fallback.

Parametersโ€‹

valueโ€‹

unknown

Value to convert to timeout in milliseconds

defaultValueโ€‹

Fallback value if conversion fails (default: 10000)

number | TimeoutMilliseconds

Returnsโ€‹

TimeoutMilliseconds

Valid positive timeout value in milliseconds, or the default value

Remarksโ€‹

Ensures the result is a positive integer number of milliseconds suitable for timeout operations. Zero and negative values are considered invalid for timeouts and will return the default value.

Exampleโ€‹

safeParseTimeout("5000"); // 5000 (5 seconds)
safeParseTimeout("0"); // 10000 (invalid timeout)
safeParseTimeout("-1000"); // 10000 (negative timeout)
safeParseTimeout("invalid"); // 10000