Skip to content

Commit 1826d0b

Browse files
docs(guardBoolean): update
1 parent 3412d23 commit 1826d0b

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

packages/type/src/guard/lib/guard-boolean.func.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ import { GuardBoolean } from '../type/guard-boolean.type';
66
import { 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
*/
1313
export const guardBoolean: GuardBoolean = <B extends AnyBoolean>(value: B, callback?: ResultCallback): value is B =>
1414
isBoolean(value, callback);

0 commit comments

Comments
 (0)