UNPKG

1.13 kBTypeScriptView Raw
1import { _Pick } from './Pick';
2import { Depth } from './_Internal';
3import { Key } from '../Any/Key';
4import { PatchFlat } from './Patch';
5import { BuiltIn } from '../Misc/BuiltIn';
6/**
7 * @hidden
8 */
9export declare type WritableFlat<O> = {
10 -readonly [K in keyof O]: O[K];
11} & {};
12/**
13 * @hidden
14 */
15export declare type WritableDeep<O> = {
16 -readonly [K in keyof O]: O[K] extends BuiltIn ? O[K] : WritableDeep<O[K]>;
17};
18/**
19 * @hidden
20 */
21export declare type WritablePart<O extends object, depth extends Depth> = {
22 'flat': WritableFlat<O>;
23 'deep': WritableDeep<O>;
24}[depth];
25/**
26 * @hidden
27 */
28export declare type _Writable<O extends object, K extends Key, depth extends Depth> = PatchFlat<WritablePart<_Pick<O, K>, depth>, O>;
29/**
30 * Make some fields of `O` writable (deeply or not)
31 * @param O to make writable
32 * @param K (?=`Key`) to choose fields
33 * @param depth (?=`'flat'`) 'deep' to do it deeply
34 * @returns [[Object]]
35 * @example
36 * ```ts
37 * ```
38 */
39export declare type Writable<O extends object, K extends Key = Key, depth extends Depth = 'flat'> = O extends unknown ? _Writable<O, K, depth> : never;