type/check.ts

  1. /**
  2.  * Type tools.
  3.  *
  4.  * @module type
  5.  * @license Apache-2.0
  6.  * @copyright Mat. 2018-present
  7.  */
  9. /* eslint-disable @typescript-eslint/no-explicit-any */
  11. import type { Fun, JSAnyObj } from "../type/defs";
  16. /**
  17.  * Determine if a given value is an `Array`.
  18.  *
  19.  * @function isArray
  20.  * @param {unknown} c
  21.  * @returns {Boolean}
  22.  */
  23. export const isArray = Array.isArray;
  28. /**
  29.  * Determine if a given value is a `Boolean`.
  30.  *
  31.  * @function isBoolean
  32.  * @param {unknown} c
  33.  * @returns {Boolean}
  34.  */
  35. export const isBoolean = (c: unknown): c is boolean =>
  36.     c != null  &&  "boolean" === typeof c;
  41. /**
  42.  * Determine if a given value is of `Date` type.
  43.  *
  44.  * @function isDate
  45.  * @param {unknown} c
  46.  * @returns {Date}
  47.  */
  48. export const isDate = (c: unknown): c is Date => c instanceof Date;
  53. /**
  54.  * Determine if a given value is a `Function`.
  55.  *
  56.  * @function isFunction
  57.  * @param {unknown} c
  58.  * @returns {Boolean}
  59.  */
  60. export const isFunction = (c: unknown): c is Fun =>
  61.     c != null  &&  "function" === typeof c;
  66. /**
  67.  * Determine if a given value is a proper `Number`
  68.  * (not `NaN` and not `Infinity`).
  69.  *
  70.  * @function isNumber
  71.  * @param {unknown} c
  72.  * @returns {Boolean}
  73.  */
  74. export const isNumber = (c: unknown): c is number =>
  75.     c != null  &&  "number" === typeof c  &&
  76.     !Number.isNaN(c)  &&  Number.isFinite(c);
  81. /**
  82.  * Determine if a given value is an `Object`
  83.  * (not `null`, not `undefined` and not `Array`).
  84.  *
  85.  * @function isObject
  86.  * @param {unknown} c
  87.  * @returns {Boolean}
  88.  */
  89. export const isObject = (c: unknown): c is JSAnyObj =>
  90.     c != null  &&  "object" === typeof c  &&  !isArray(c);
  95. /**
  96.  * Determine if a given value is of `RegExp` type.
  97.  *
  98.  * @function isRegExp
  99.  * @param {unknown} c
  100.  * @returns {RegExp}
  101.  */
  102. export const isRegExp = (c: unknown): c is RegExp => c instanceof RegExp;
  107. /**
  108.  * Determine if a given value is a `String`.
  109.  *
  110.  * @function isString
  111.  * @param {unknown} c
  112.  * @returns {Boolean}
  113.  */
  114. export const isString = (c: unknown): c is string =>
  115.     c != null  &&  "string" === typeof c;