MakeOptional

Since 1.3.0

Make specific keys optional in an object type.

Signature

type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [P in K]+?: T[P] }

Parameters

Parameter	Description
T	The object type
K	The keys to make optional

Examples

Basic Usage

import type { MakeOptional } from 'uni-types'

type User = { name: string; age: number; email: string }
type PartialUser = MakeOptional<User, 'age' | 'email'>
// { name: string } & { age?: number } & { email?: string }

With Single Key

type Config = { host: string; port: number }
type FlexibleConfig = MakeOptional<Config, 'port'> // { host: string } & { port?: number }

Creating Form Types

type FormData = { username: string; password: string; rememberMe: boolean }
type FormInput = MakeOptional<FormData, 'rememberMe'>
// { username: string; password: string } & { rememberMe?: boolean }

Related

• RequireKeys - Make specific keys required
• RequireAtLeastOne - Require at least one key