Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export { default as useMergedState } from './hooks/useMergedState';
export { default as useControlledState } from './hooks/useControlledState';
export { supportNodeRef, supportRef, useComposeRef } from './ref';
export { default as get } from './utils/get';
export { default as set, merge } from './utils/set';
export { default as set, merge, mergeWith } from './utils/set';
export { default as warning, noteOnce } from './warning';
export { default as omit } from './omit';
export { default as toArray } from './Children/toArray';
29 changes: 26 additions & 3 deletions src/utils/set.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,25 @@ function createEmpty<T>(source: T) {

const keys = typeof Reflect === 'undefined' ? Object.keys : Reflect.ownKeys;

// ================================ Merge ================================
export type MergeFn = (current: any, next: any) => any;

/**
* Merge objects which will create
* Merge multiple objects. Support custom merge logic.
* @param sources object sources
* @param config.prepareArray Customize array prepare function.
* It will return empty [] by default.
* So when match array, it will auto be override with next array in sources.
*/
export function merge<T extends object>(...sources: T[]) {
export function mergeWith<T extends object>(
sources: T[],
config: {
prepareArray?: MergeFn;
} = {},
) {
const { prepareArray } = config;
const finalPrepareArray: MergeFn = prepareArray || (() => []);

let clone = createEmpty(sources[0]);

sources.forEach(src => {
Expand All @@ -89,7 +104,7 @@ export function merge<T extends object>(...sources: T[]) {

if (isArr) {
// Array will always be override
clone = set(clone, path, []);
clone = set(clone, path, finalPrepareArray(originValue, value));
} else if (!originValue || typeof originValue !== 'object') {
// Init container if not exist
clone = set(clone, path, createEmpty(value));
Expand All @@ -109,3 +124,11 @@ export function merge<T extends object>(...sources: T[]) {

return clone;
}

/**
* Merge multiple objects into a new single object.
* Arrays will be replaced by default.
*/
export function merge<T extends object>(...sources: T[]) {
return mergeWith(sources);
}
35 changes: 34 additions & 1 deletion tests/utils.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import pickAttrs from '../src/pickAttrs';
import get from '../src/utils/get';
import set, { merge } from '../src/utils/set';
import set, { mergeWith, merge } from '../src/utils/set';

describe('utils', () => {
it('get', () => {
Expand Down Expand Up @@ -252,6 +252,39 @@ describe('utils', () => {
[symbol]: 1,
});
});

it('customMerge for custom logic', () => {
const src = {
rest: 233,
list: [
{
a: 1,
},
],
};
const tgt = {
list: [
{
b: 1,
},
],
};

const merged = mergeWith<any>([src, tgt], {
prepareArray: current => {
return [...(current || [])];
},
});
expect(merged).toEqual({
rest: 233,
list: [
{
a: 1,
b: 1,
},
],
});
});
});
});

Expand Down
Loading