File tree Expand file tree Collapse file tree
packages/type/src/guard/lib Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -6,9 +6,9 @@ import { GuardBoolean } from '../type/guard-boolean.type';
66import { ResultCallback } from '../../type/result-callback.type' ;
77/**
88 * Guard the `value` to be any type of a boolean.
9- * @param value A `boolean ` type `value` to guard.
9+ * @param value An `AnyBoolean ` type `value` to guard.
1010 * @param callback An optional `ResultCallback` function to handle result before returns.
11- * @returns A `boolean` indicating whether or not the `value` is a `boolean` or `Boolean`.
11+ * @returns A `boolean` indicating whether or not the `value` is a `boolean` type or `Boolean` object .
1212 */
1313export const guardBoolean : GuardBoolean = < B extends AnyBoolean > ( value : B , callback ?: ResultCallback ) : value is B =>
1414 isBoolean ( value , callback ) ;
You can’t perform that action at this time.
0 commit comments