Toolkit

Appearance

Documentation / @andrew_l/toolkit / isTimeValue

Function: isTimeValue() ​

isTimeValue(value): value is TimeValue

Checks if a given value is a valid TimeValue.

Parameters ​

value ​

unknown

The value to check if it's a valid TimeValue.

Returns ​

value is TimeValue

  • Returns true if the value is a valid TimeValue, otherwise false.

Examples ​

ts
// Valid TimeObject
isTimeValue({ h: 15, m: 30 }); // true
ts
// Valid TimeString
isTimeValue('15:30'); // true