Skip to main content

SetOptional<BaseType, Keys>

SetOptional<BaseType, Keys> = BaseType extends unknown ? Simplify<Except<BaseType, Keys> & Partial<HomomorphicPick<BaseType, Keys>>> : never

Defined in: packages/react-querybuilder/src/types/type-fest/set-optional.ts:31

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.

Type Parameters​

Type Parameter
BaseType
Keys extends keyof BaseType

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.
// }
caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.