.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / type-fest / source / set-optional.d.ts
1 import {Except} from './except';
2
3 /**
4 Create a type that makes the given keys optional. The remaining keys are kept as is. The sister of the `SetRequired` type.
5
6 Use-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 ```
10 import {SetOptional} from 'type-fest';
11
12 type Foo = {
13         a: number;
14         b?: string;
15         c: boolean;
16 }
17
18 type 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 */
26 export 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;