import type {BuiltIns, HasMultipleCallSignatures} from './internal'; /** Create a deeply mutable version of an `object`/`ReadonlyMap`/`ReadonlySet`/`ReadonlyArray` type. The inverse of `ReadonlyDeep`. Use `Writable` if you only need one level deep. This can be used to [store and mutate options within a class](https://github.com/sindresorhus/pageres/blob/4a5d05fca19a5fbd2f53842cbf3eb7b1b63bddd2/source/index.ts#L72), [edit `readonly` objects within tests](https://stackoverflow.com/questions/50703834), [construct a `readonly` object within a function](https://github.com/Microsoft/TypeScript/issues/24509), or to define a single model where the only thing that changes is whether or not some of the keys are writable. @example ``` import type {WritableDeep} from 'type-fest'; type Foo = { readonly a: number; readonly b: readonly string[]; // To show that mutability is deeply affected. readonly c: boolean; }; const writableDeepFoo: WritableDeep = {a: 1, b: ['2'], c: true}; writableDeepFoo.a = 3; writableDeepFoo.b[0] = 'new value'; writableDeepFoo.b = ['something']; ``` Note that types containing overloaded functions are not made deeply writable due to a [TypeScript limitation](https://github.com/microsoft/TypeScript/issues/29732). @see Writable @category Object @category Array @category Set @category Map */ export type WritableDeep = T extends BuiltIns ? T : T extends (...arguments_: any[]) => unknown ? {} extends WritableObjectDeep ? T : HasMultipleCallSignatures extends true ? T : ((...arguments_: Parameters) => ReturnType) & WritableObjectDeep : T extends ReadonlyMap ? WritableMapDeep : T extends ReadonlySet ? WritableSetDeep : T extends readonly unknown[] ? WritableArrayDeep : T extends object ? WritableObjectDeep : unknown; /** Same as `WritableDeep`, but accepts only `Map`s as inputs. Internal helper for `WritableDeep`. */ type WritableMapDeep> = MapType extends ReadonlyMap ? Map, WritableDeep> : MapType; // Should not heppen /** Same as `WritableDeep`, but accepts only `Set`s as inputs. Internal helper for `WritableDeep`. */ type WritableSetDeep> = SetType extends ReadonlySet ? Set> : SetType; // Should not heppen /** Same as `WritableDeep`, but accepts only `object`s as inputs. Internal helper for `WritableDeep`. */ type WritableObjectDeep = { -readonly [KeyType in keyof ObjectType]: WritableDeep }; /** Same as `WritableDeep`, but accepts only `Array`s as inputs. Internal helper for `WritableDeep`. */ type WritableArrayDeep = ArrayType extends readonly [] ? [] : ArrayType extends readonly [...infer U, infer V] ? [...WritableArrayDeep, WritableDeep] : ArrayType extends readonly [infer U, ...infer V] ? [WritableDeep, ...WritableArrayDeep] : ArrayType extends ReadonlyArray ? Array> : ArrayType extends Array ? Array> : ArrayType;