Skip to content

Commit cbd1cdc

Browse files
docs(isNumber): update jsdoc
1 parent ca4fd1e commit cbd1cdc

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

packages/type/src/is/lib/is-number.func.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import { ResultCallback } from '../../type/result-callback.type';
1111
* @param value Any `value` to check.
1212
* @param callback `ResultCallback` function to handle result before returns.
1313
* @callback `resultCallback`.
14-
* @returns A `boolean` indicating whether or not the `value` is a `number`.
14+
* @returns A `boolean` indicating whether or not the `value` is a `number` type or `Number` object.
1515
*/
1616
export const isNumber: IsNumber = (value: any, callback: ResultCallback = resultCallback): value is number =>
1717
callback(typeOf(value) === 'number' && isFinite(value) === true && (isNumberType(value) || isNumberObject(value)), value);

0 commit comments

Comments
 (0)