DeepRequired

Since 1.0.0

Make all nested properties required recursively.

Signature

type DeepRequired<T> = T extends BuiltIn
  ? T
  : T extends Map<infer K, infer V>
    ? Map<DeepRequired<K>, DeepRequired<V>>
    : T extends Set<infer V>
      ? Set<DeepRequired<V>>
      : T extends (infer E)[]
        ? DeepRequired<E>[]
        : T extends object
          ? { [P in keyof T]-?: DeepRequired<T[P]> }
          : T

Parameters

Parameter	Description
T	The target type

Description

Unlike TypeScript's built-in Required<T>, DeepRequired recursively makes all nested properties required.

Examples

Basic Usage

import type { DeepRequired } from 'uni-types'

interface Config {
  database?: {
    host?: string
    port?: number
  }
}

type RequiredConfig = DeepRequired<Config>
/*
{
  database: {
    host: string
    port: number
  }
}
*/

With Arrays

interface Data {
  items?: (string | undefined)[]
}

type RequiredData = DeepRequired<Data>
// items becomes string[] (undefined removed from elements)

Related

• DeepPartial - Make all nested properties optional
• DeepReadonly - Make all nested properties readonly
• DeepMutable - Make all nested properties mutable