source: node_modules/type-fest/source/set-optional.d.ts

main
Last change on this file was d24f17c, checked in by Aleksandar Panovski <apano77@…>, 15 months ago

Initial commit

  • Property mode set to 100644
File size: 1.0 KB
Line 
1import {Except} from './except';
2
3/**
4Create a type that makes the given keys optional. The remaining keys are kept as is. The sister of the `SetRequired` type.
5
6Use-case: You want to define a single model where the only thing that changes is whether or not some of the keys are optional.
7
8@example
9```
10import {SetOptional} from 'type-fest';
11
12type Foo = {
13 a: number;
14 b?: string;
15 c: boolean;
16}
17
18type SomeOptional = SetOptional<Foo, 'b' | 'c'>;
19// type SomeOptional = {
20// a: number;
21// b?: string; // Was already optional and still is.
22// c?: boolean; // Is now optional.
23// }
24```
25*/
26export type SetOptional<BaseType, Keys extends keyof BaseType = keyof BaseType> =
27 // Pick just the keys that are not optional from the base type.
28 Except<BaseType, Keys> &
29 // Pick the keys that should be optional from the base type and make them optional.
30 Partial<Pick<BaseType, Keys>> extends
31 // If `InferredType` extends the previous, then for each key, use the inferred type key.
32 infer InferredType
33 ? {[KeyType in keyof InferredType]: InferredType[KeyType]}
34 : never;
Note: See TracBrowser for help on using the repository browser.