Type alias SetRequired<BaseType, Keys>

SetRequired<BaseType, Keys>: BaseType extends unknown
    ? Simplify<Except<BaseType, Keys> & Required<Pick<BaseType, Keys>>>
    : never

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

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

Generated using TypeDoc