Skip to content

Commit 1379f65

Browse files
docs(guardDefined): update jsdoc
1 parent 254225d commit 1379f65

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

packages/type/src/guard/lib/guard-defined.type.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ import { Defined } from '../../type/defined.type';
55
import { GuardDefined } from '../type/guard-defined.type';
66
import { ResultCallback } from '../../type/result-callback.type';
77
/**
8-
* Checks if a generic type `value` is NOT an `undefined` type and is NOT equal to `undefined`.
9-
* @param value A generic type `value` to check.
8+
* Guard the `value` to be defined.
9+
* @param value A generic type `value` to guard.
1010
* @param callback An optional `ResultCallback` function to handle result before returns.
1111
* @returns A `boolean` indicating whether or not the `value` is defined, if `undefined` then returns `never`.
1212
*/

0 commit comments

Comments
 (0)