tabshift/hotscript
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: ➕ add jsdocs with examples

Browse Source
This commit is contained in:
Alexey Berezin
2023-02-27 22:16:58 +00:00
committed by gvergnaud
parent 4d2481275b
commit ed871a89c0
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/internals/objects/Objects.ts
View File

@@ -384,18 +384,20 @@ export namespace Objects {
}
/**
* Makes all levels of an object optional
* @description This function is used to make all levels of an object optional
* @param obj - The object to make levels optional
* @returns The object with its levels made optional
*
* Makes all levels of an object partial
* @description This function is used to make all levels of an object partial
* @param obj - The object to make levels partial
* @returns The object with its levels made partial
* @example
* ```ts
* type T0 = Call<Objects.PartialDeep, {a: 1; b: true }>; // { a?:1; b?: true}
* type T1 = Call<Objects.PartialDeep, {a: 1; b: { c: true } }>; // { a?:1; b?: { c?: true } }
* type T2 = Call<Objects.PartialDeep, {a: 1; b: { c: true, d: { e: false } } }>; // { a?:1; b?: { c?: true, d?: { e?: false } } }
* type T0 = Call<Objects.PartialDeep, {a: 1; b: true}>;
* // ^? {a?: 1; b?: true}
* type T1 = Call<Objects.PartialDeep, {a: 1; b: {c: true}}>;
* // ^? {a?: 1; b?: {c?: true}}
* type T2 = Call<Objects.PartialDeep, {a: 1; b: {c: true, d: {e: false}}}>;
* // ^? {a?: 1; b?: {c?: true, d?: {e?: false}}}
* ```
*/
export type PartialDeep<obj = unset> = PartialApply<PartialDeepFn, [obj]>;
interface PartialDeepFn extends Fn {