refactor(guards)!: require value parameter

Signed-off-by: Lexus Drumgold <[email protected]>

src/guards/is-app-env.ts

@@ -6,12 +6,12 @@
 import AppEnv from '#src/enums/app-env'
 
 /**
- * Checks if `value` is an {@link AppEnv}.
+ * Checks if the given `value` is a valid app environment.
  *
- * @param {any} [value] - Value to check
- * @return {boolean} `true` if `value` is valid app environment
+ * @param {unknown} value - Value to evaluate
+ * @return {value is AppEnv} `true` if `value` is {@linkcode AppEnv}
  */
-const isAppEnv = (value?: any): value is AppEnv => {
+const isAppEnv = (value: unknown): value is AppEnv => {
   return Object.values(AppEnv).includes(value as AppEnv)
 }
 

src/guards/is-booleanish.ts

@@ -6,12 +6,12 @@
 import type { Booleanish } from '#src/types'
 
 /**
- * Checks if `value` is {@link Booleanish}.
+ * Checks if the given `value` is a boolean, `'false'`, or `'true'`.
  *
- * @param {any} [value] - Value to check
- * @return {boolean} `true` if `value` is a `boolean`, `'false'`, or `'true'`
+ * @param {unknown} value - Value to evaluate
+ * @return {value is Booleanish} `true` if `value` is {@linkcode Booleanish}
  */
-const isBooleanish = (value?: any): value is Booleanish => {
+const isBooleanish = (value: unknown): value is Booleanish => {
   return typeof value === 'boolean' || value === 'false' || value === 'true'
 }
 

src/guards/is-empty-string.ts

@@ -6,12 +6,12 @@
 import type { EmptyString } from '#src/types'
 
 /**
- * Checks if `value` is an empty string.
+ * Checks if the given `value` is an empty string.
  *
- * @param {any} [value] - Value to check
- * @return {boolean} `true` if `value` is an empty string
+ * @param {unknown} value - Value to evaluate
+ * @return {value is EmptyString} `true` if `value` is empty string
  */
-const isEmptyString = (value?: any): value is EmptyString => {
+const isEmptyString = (value: unknown): value is EmptyString => {
   return typeof value !== 'string' ? false : value.trim() === ''
 }
 

src/guards/is-empty-value.ts

@@ -8,12 +8,12 @@ import isEmptyString from './is-empty-string'
 import isNIL from './is-nil'
 
 /**
- * Checks if `value` is an empty string or `NIL`.
+ * Checks if the given `value` is an empty string, `null`, or `undefined`.
  *
- * @param {any} [value] - Value to check
- * @return {boolean} `true` if `value` is empty string, `null`, or `undefined`
+ * @param {unknown} value - Value to evaluate
+ * @return {value is EmptyValue} `true` if `value` is empty
  */
-const isEmptyValue = (value?: any): value is EmptyValue => {
+const isEmptyValue = (value: unknown): value is EmptyValue => {
   return isEmptyString(value) || isNIL(value)
 }
 

src/guards/is-jwt-type.ts

@@ -6,12 +6,12 @@
 import JwtType from '#src/enums/jwt-type'
 
 /**
- * Checks if `value` is a {@link JwtType}.
+ * Checks if the given `value` is a valid JSON web token type.
  *
- * @param {any} [value] - Value to check
- * @return {boolean} `true` if `value` is valid jwt type
+ * @param {unknown} value - Value to evaluate
+ * @return {value is JwtType} `true` if `value` is {@linkcode JwtType}
  */
-const isJwtType = (value?: any): value is JwtType => {
+const isJwtType = (value: unknown): value is JwtType => {
   return Object.values(JwtType).includes(value as JwtType)
 }
 

src/guards/is-nil.ts

@@ -6,12 +6,12 @@
 import type { NIL } from '#src/types'
 
 /**
- * Checks if `value` is a {@link NIL}.
+ * Checks if the given `value` is `null` or `undefined`.
  *
- * @param {any} [value] - Value to check
- * @return {boolean} `true` if `value` is `null` or `undefined`
+ * @param {unknown} value - Value to evaluate
+ * @return {value is NIL} `true` if `value` is {@linkcode NIL}
  */
-const isNIL = (value?: any): value is NIL => {
+const isNIL = (value: unknown): value is NIL => {
   return value === null || value === undefined
 }
 

src/guards/is-node-env.ts

@@ -6,12 +6,12 @@
 import NodeEnv from '#src/enums/node-env'
 
 /**
- * Checks if `value` is a {@link NodeEnv}.
+ * Checks if the given `value` is a valid node environment.
  *
- * @param {any} [value=process.env.NODE_ENV] - Value to check
- * @return {boolean} `true` if `value` is valid node environment
+ * @param {unknown} [value=process.env.NODE_ENV] - Value to evaluate
+ * @return {value is NodeEnv} `true` if `value` is {@linkcode NodeEnv}
  */
-const isNodeEnv = (value: any = process.env.NODE_ENV): value is NodeEnv => {
+const isNodeEnv = (value: unknown = process.env.NODE_ENV): value is NodeEnv => {
   return Object.values(NodeEnv).includes(value as NodeEnv)
 }
 

src/guards/is-unix-timestamp.ts

@@ -6,15 +6,15 @@
 import type { TimestampUnix } from '#src/types'
 
 /**
- * Checks if `timestamp` is a valid [unix timestamp][1].
+ * Checks if the given `value` is a valid [unix timestamp][1].
  *
  * [1]: https://unixtimestamp.com
  *
- * @param {any} [timestamp] - Value to check
- * @return {boolean} `true` if `timestamp` is valid unix timestamp
+ * @param {unknown} value - Value to evaluate
+ * @return {value is TimestampUnix} `true` if `value` is valid unix timestamp
  */
-const isUnixTimestamp = (timestamp?: any): timestamp is TimestampUnix => {
-  return typeof timestamp === 'number' && new Date(timestamp).getTime() > 0
+const isUnixTimestamp = (value: unknown): value is TimestampUnix => {
+  return typeof value === 'number' && new Date(value).getTime() > 0
 }
 
 export default isUnixTimestamp