Skip to main content
Module

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

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

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.

Examples

Example 1

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

Type Parameters

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