Sha256: cec67731fce8577b0a90aa67ef0522ddb9f1fd681bece50cdcb80a833b4ed06f

Contents?: true

Size: 944 Bytes

Versions: 33

Compression:

Stored size: 944 Bytes

Contents

import type {Except} from './except';
import type {Simplify} from './simplify';

/**
Create a type that makes the given keys optional. The remaining keys are kept as is. The sister of the `SetRequired` type.

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.

@example
```
import type {SetOptional} from 'type-fest';

type Foo = {
	a: number;
	b?: string;
	c: boolean;
}

type SomeOptional = SetOptional<Foo, 'b' | 'c'>;
// type SomeOptional = {
// 	a: number;
// 	b?: string; // Was already optional and still is.
// 	c?: boolean; // Is now optional.
// }
```

@category Object
*/
export type SetOptional<BaseType, Keys extends keyof BaseType> =
	Simplify<
		// Pick just the keys that are readonly from the base type.
		Except<BaseType, Keys> &
		// Pick the keys that should be mutable from the base type and make them mutable.
		Partial<Pick<BaseType, Keys>>
	>;

Version data entries

33 entries across 33 versions & 1 rubygems

Version Path
immosquare-cleaner-0.1.60 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.59 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.58 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.57 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.56 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.55 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.54 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.53 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.52 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.51 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.50 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.49 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.48 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.47 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.46 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.45 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.44 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.43 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.42 node_modules/type-fest/source/set-optional.d.ts
immosquare-cleaner-0.1.41 node_modules/type-fest/source/set-optional.d.ts