@philiprehberger/deep-merge-ts
v0.1.4529 downloadsMIT
Type-safe deep merging of objects
$
npm install @philiprehberger/deep-merge-tsREADME
@philiprehberger/deep-merge-ts
Type-safe deep merging of objects
Installation
npm install @philiprehberger/deep-merge-ts
Usage
import { deepMerge, deepMergeAll } from '@philiprehberger/deep-merge-ts';
const config = deepMerge(
{ server: { port: 3000, host: 'localhost' }, debug: false },
{ server: { port: 8080 }, debug: true },
);
// { server: { port: 8080, host: 'localhost' }, debug: true }
// Return type is fully inferred
const merged = deepMergeAll([base, env, runtime]);
Array Strategies
deepMerge({ tags: ['a'] }, { tags: ['b'] });
// { tags: ['b'] } — default: replace
deepMerge({ tags: ['a'] }, { tags: ['b'] }, { arrayStrategy: 'concat' });
// { tags: ['a', 'b'] }
deepMerge({ tags: ['a', 'b'] }, { tags: ['b', 'c'] }, { arrayStrategy: 'union' });
// { tags: ['a', 'b', 'c'] }
API
| Function | Description |
|---|---|
deepMerge(target, source, options?) | Deep merge two objects with type inference |
deepMergeAll(objects[], options?) | Merge N objects left-to-right |
isPlainObject(value) | Check if a value is a plain object |
Development
npm install
npm run build
npm test
Support
If you find this project useful: