Debian Codegraph @

smob/dist/index.d.mts

raw
1 //#region src/constants.d.ts
2 declare enum PriorityName {
3 LEFT = "left",
4 RIGHT = "right"
5 }
6 //#endregion
7 //#region src/type.d.ts
8 type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
9 type Options = {
10 /**
11 * Merge object array properties.
12 *
13 * default: true
14 */
15 array: boolean;
16 /**
17 * Remove duplicates, when merging array elements.
18 *
19 * default: false
20 */
21 arrayDistinct: boolean;
22 /**
23 * Merge sources from left-to-right or right-to-left.
24 * From v2 upwards default to left independent of the option priority.
25 *
26 * default: left (aka. options.priority)
27 */
28 arrayPriority: `${PriorityName}`;
29 /**
30 * Strategy to merge different object keys.
31 *
32 * @param target
33 * @param key
34 * @param value
35 */
36 strategy?: (target: Record<string, any>, key: string, value: unknown) => Record<string, any> | undefined;
37 /**
38 * Merge sources in place.
39 *
40 * default: false
41 */
42 inPlace?: boolean;
43 /**
44 * Deep clone input sources.
45 *
46 * default: false
47 */
48 clone?: boolean;
49 /**
50 * Merge sources from left-to-right or right-to-left.
51 * From v2 upwards default to right.
52 *
53 * default: left
54 */
55 priority: `${PriorityName}`;
56 };
57 type OptionsInput = Partial<Options>;
58 type MergerSource = any[] | Record<string, any>;
59 type MergerSourceUnwrap<T extends MergerSource> = T extends Array<infer Return> ? Return : T;
60 type MergerResult<B extends MergerSource> = UnionToIntersection<MergerSourceUnwrap<B>>;
61 type MergerContext = {
62 options: Options;
63 map: WeakMap<any, any>;
64 };
65 type Merger = <B extends MergerSource[]>(...sources: B) => MergerResult<B>;
66 //#endregion
67 //#region src/module.d.ts
68 declare function createMerger(input?: OptionsInput): Merger;
69 declare const merge: Merger;
70 //#endregion
71 //#region src/utils/array.d.ts
72 declare function distinctArray<T = any>(arr: T[]): T[];
73 //#endregion
74 //#region src/utils/check.d.ts
75 declare function isObject(item: unknown): item is Record<string, any>;
76 declare function isSafeKey(key: string): boolean;
77 declare function isEqual(x: any, y: any): boolean;
78 //#endregion
79 //#region src/utils/clone.d.ts
80 declare function polyfillClone<T>(input: T): T;
81 declare function clone<T>(value: T): T;
82 //#endregion
83 //#region src/utils/object.d.ts
84 declare function hasOwnProperty<X extends {}, Y extends PropertyKey>(obj: X, prop: Y): obj is X & Record<Y, unknown>;
85 //#endregion
86 //#region src/utils/options.d.ts
87 declare function buildOptions(options?: OptionsInput): Options;
88 declare function togglePriority(priority: `${PriorityName}`): "right" | "left";
89 //#endregion
90 //#region src/presets.d.ts
91 /**
92 * Assign source attributes to a target object.
93 *
94 * @param target
95 * @param sources
96 */
97 declare function assign<A extends Record<string, any>, B extends Record<string, any>[]>(target: A, ...sources: B): A & MergerResult<B>;
98 //#endregion
99 export { Merger, MergerContext, MergerResult, MergerSource, MergerSourceUnwrap, Options, OptionsInput, PriorityName, assign, buildOptions, clone, createMerger, distinctArray, hasOwnProperty, isEqual, isObject, isSafeKey, merge, polyfillClone, togglePriority };
100 //# sourceMappingURL=index.d.mts.map