DeepMutable

Since 1.0.0

Make all nested properties mutable (remove readonly) recursively.

Signature

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

Parameters

Parameter	Description
T	The target type

Description

DeepMutable is the opposite of DeepReadonly. It removes all readonly modifiers from all nested properties.

Examples

Basic Usage

import type { DeepMutable } from 'uni-types'

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

type MutableConfig = DeepMutable<Config>
/*
{
  database: {
    host: string
    port: number
  }
}
*/

With Readonly Arrays

type ReadonlyArray = readonly string[]
type MutableArray = DeepMutable<ReadonlyArray> // string[]

With DeepReadonly

import type { DeepReadonly, DeepMutable } from 'uni-types'

interface Data {
  items: { name: string }[]
}

type Readonly = DeepReadonly<Data>
type BackToMutable = DeepMutable<Readonly> // Same as Data

Related

• DeepReadonly - Make all nested properties readonly
• DeepPartial - Make all nested properties optional
• DeepRequired - Make all nested properties required