Skip to content

Commit

Permalink
docs: update undefined docs
Browse files Browse the repository at this point in the history
  • Loading branch information
unional committed Sep 25, 2023
1 parent c170d32 commit 3503ed9
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
3 changes: 3 additions & 0 deletions type-plus/ts/undefined/is_not_undefined.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ import type { SelectInvertWithDistribute } from '../type_plus/branch/select_inve
* @example
* ```ts
* type R = IsNotUndefined<undefined, { selection: 'filter-unknown' }> // unknown
*
* type R = IsNotUndefined<string | boolean, { selection: 'filter-unknown' }> // string | boolean
* type R = IsNotUndefined<string | undefined, { selection: 'filter-unknown' }> // unknown
* ```
*
* 🔢 *customize*
Expand Down
5 changes: 1 addition & 4 deletions type-plus/ts/undefined/is_undefined.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,8 @@ import type { SelectWithDistribute } from '../type_plus/branch/select_with_distr
*
* @example
* ```ts
* type R = IsUndefined<undefined, { selection: 'filter-unknown' }> // undefined
*
* type R = IsUndefined<never, { selection: 'filter-unknown' }> // unknown
* type R = IsUndefined<unknown, { selection: 'filter-unknown' }> // unknown
* type R = IsUndefined<string | boolean, { selection: 'filter-unknown' }> // unknown
* type R = IsUndefined<string | undefined, { selection: 'filter-unknown' }> // unknown
* ```
*
* 🔢 *customize*:
Expand Down
8 changes: 4 additions & 4 deletions type-plus/ts/undefined/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,8 @@ type R = IsUndefined<string | undefined> // undefined
Filter to ensure `T` is `undefined`, otherwise returns `unknown`.
```ts
type R = IsUndefined<undefined, { selection: 'filter-unknown' }> // undefined

type R = IsUndefined<never, { selection: 'filter-unknown' }> // unknown
type R = IsUndefined<unknown, { selection: 'filter-unknown' }> // unknown
type R = IsUndefined<string | boolean, { selection: 'filter-unknown' }> // unknown
type R = IsUndefined<string | undefined, { selection: 'filter-unknown' }> // unknown
```
🔢 *customize*:
Expand Down Expand Up @@ -98,6 +95,9 @@ Filter to ensure `T` is not `undefined`, otherwise returns `unknown`.
```ts
type R = IsNotUndefined<undefined, { selection: 'filter-unknown' }> // unknown

type R = IsNotUndefined<string | boolean, { selection: 'filter-unknown' }> // string | boolean
type R = IsNotUndefined<string | undefined, { selection: 'filter-unknown' }> // unknown
```
🔢 *customize*
Expand Down

0 comments on commit 3503ed9

Please sign in to comment.