31 lines
787 B
JavaScript
31 lines
787 B
JavaScript
//#region src/compat/predicate/isFinite.ts
|
|
/**
|
|
* Checks if `value` is a finite number.
|
|
*
|
|
* Acts as a type guard for `number` values — returning `true` only when `value`
|
|
* is of type `number` and finite (not `Infinity`, `-Infinity`, or `NaN`).
|
|
*
|
|
* @param {unknown} value The value to check.
|
|
* @returns {value is number} Returns `true` if `value` is a finite number, `false` otherwise.
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* const value1 = 100;
|
|
* const value2 = Infinity;
|
|
* const value3 = '100';
|
|
*
|
|
* console.log(isFinite(value1)); // true
|
|
* console.log(isFinite(value2)); // false
|
|
* console.log(isFinite(value3)); // false
|
|
*
|
|
* if (isFinite(value1)) {
|
|
* console.log(value1.toFixed(2));
|
|
* }
|
|
* ```
|
|
*/
|
|
function isFinite(value) {
|
|
return Number.isFinite(value);
|
|
}
|
|
//#endregion
|
|
export { isFinite };
|