Skip to main content
Module

x/scaffold/src/deps/types.ts>SetRequired

scaffold your next project with style and 💗
ifiokjr/scaffold
Latest
type alias SetRequired
import { type SetRequired } from "https://deno.land/x/scaffold@0.3.0/src/deps/types.ts";

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.

Examples

Example 1

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

Type Parameters

BaseType
Keys extends keyof BaseType
definition: Simplify<Except<BaseType, Keys> & Required<Pick<BaseType, Keys>>>