Skip to main content

SetRequired<BaseType, Keys>

SetRequired<BaseType, Keys> = BaseType extends UnknownArray ? SetArrayRequired<BaseType, Keys> extends infer ResultantArray ? IfArrayReadonly<BaseType, Readonly<ResultantArray>, ResultantArray> : never : Simplify<Except<BaseType, Keys> & Required<HomomorphicPick<BaseType, Keys>>>

Defined in: packages/react-querybuilder/src/types/type-fest/set-required.ts:37

Create a type that makes the given keys required. The remaining keys are kept as is. The sister of the SetOptional 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 required.

Type Parameters​

Type Parameter
BaseType
Keys extends keyof BaseType

Example​

import type {SetRequired} from 'type-fest';

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

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

// Set specific indices in an array to be required.
type ArrayExample = SetRequired<[number?, number?, number?], 0 | 1>;
//=> [number, number, number?]
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.