Skip to main content

Function: safeParsePositiveInt()

safeParsePositiveInt(value: unknown, defaultValue: number): number

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

Safely converts a value to a positive integer with fallback.

Parametersโ€‹

valueโ€‹

unknown

Value to convert to positive integer

defaultValueโ€‹

number = 1

Fallback value if conversion fails (default: 1)

Returnsโ€‹

number

Valid positive integer (> 0), or the default value

Remarksโ€‹

Ensures the result is a positive integer greater than zero. Useful for counts, IDs, and other values that must be positive. Zero and negative values are considered invalid and will return the default.

Exampleโ€‹

safeParsePositiveInt("5"); // 5
safeParsePositiveInt("0"); // 1 (not positive)
safeParsePositiveInt("-3"); // 1 (not positive)
safeParsePositiveInt("invalid"); // 1