tabshift/javascript-packages
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(typescript-types): Add OptionalKeysOf<T>

Browse Source
This commit is contained in:
T. R. Bernstein
2025-07-14 07:58:16 +02:00
parent 319ccac8a7
commit 48076172bf
3 changed files with 53 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
packages/typescript-types/README.md
View File

@@ -14,8 +14,16 @@ The types included in this library are categorized by their purpose.
| [`IsNever<T>`][] | `true` if `T` is `never`, `false` otherwise (`null`, `undefined`, `any` also yield `false`) |
| [`If<Test, TrueBranch, FalseBranch>`][] | Returns `TrueBranch` if `Test` is `true`, `FalseBranch` otherwise[^if_remark]. |
[^if_remark]: Note the special behavior, if `boolean` is passed as `Test` the return value is a union of both branches, i.e. `TrueBranch | FalseBranch`.
[^if_remark]: If `boolean` is passed as `Test` the return value is a union of both branches, i.e. `TrueBranch | FalseBranch`.
[`IsAny<T>`]: src/is-any.ts
[`IsNever<T>`]: src/is-never.ts
[`If<Test, TrueBranch, FalseBranch>`]: src/if.ts
#### Extraction Types
| Type | Description |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`OptionalKeysOf<T>`][] | A union of all keys of `T` that are marked as optional. If `T` is a union, a union of the optional keys of all union members of `T` is returned. |
[`OptionalKeysOf<T>`]: src/optional-keys-of.ts