Strongly-typed deep and recursive object merging with support for all value types.
\n\n\n## Install\n\n```bash\npnpm add object-deep-merge\n```\n\n```bash\nyarn add object-deep-merge\n```\n\n```bash\nnpm install object-deep-merge\n```\n\n## Basic Usage\n\n```ts\nimport { merge } from \"object-deep-merge\";\n```\n\n### Simply merge two objects, with no nested properties\n\n```ts\nconst merged = merge({ foo: false }, { bar: true });\n\nconsole.log({ merged });\n```\n\nOutput\n\n```json\n{\n \"merged\": {\n \"foo\": false,\n \"bar\": true\n }\n}\n```\n\n\n\n## Typed Usage\n\n### `merge` Type Signature\n\nThe `merge` function accepts two optional type generics. `TData` and `TResult`.\n\n```ts\nfunction merge(\n source: TData,\n target: TData,\n ...targets: Array\n): TResult;\n```\n\n> [!IMPORTANT] \n> The [`Merge`](https://github.com/sindresorhus/type-fest/blob/main/source/merge.d.ts) and [`MergeDeep`](https://github.com/sindresorhus/type-fest/blob/main/source/merge-deep.d.ts) types from [`type-fest`](https://github.com/sindresorhus/type-fest) are great additions to this library. It is not unreasonable to use those types for your merge typing needs.\n\nWithout explicitly passing in types the function will infer the shape of the object(s) passed in.\n\n- Passing in `TData` will validate the shape of the objects passed in.\n- Passing in `TResult` will override the output type. While this should be used sparingly, it provides a convenient approach for correctly typing partial types into complete types.\n\n### Simple Example w/o Generics\n\n```ts\ntype Data = {\n name: string;\n description: string;\n};\n\nconst base: Data = { name: \"object-deep-merge\", description: \"merge objects\" };\n\nconst overrides: Partial = { description: \"merge objects, deeply\" };\n\nconst merged = merge(base, overrides);\n\n// Type is inferred so the signature becomes:\n// function merge, Partial>(source: Partial, target: Partial, ...targets: Partial[]): Partial\n\n// TData = Partial\n// TResult = Data\n\nconsole.log({ merged });\n```\n\nOutput\n\n```json\n{\n \"merged\": {\n \"name\": \"object-deep-merge\",\n \"description\": \"merge objects, deeply\"\n }\n}\n```\n\n\n\n### Simple Example w/ `TData` Generic\n\n> [!NOTE]\n> Passing in TData will validate the shape of the objects passed in.\n\n```ts\ntype Data = {\n name: string;\n description: string;\n};\n\nconst base: Data = { name: \"object-deep-merge\", description: \"merge objects\" };\n\nconst overrides: Partial = { description: \"merge objects, deeply\" };\n\nconst merged: Partial = merge>(base, overrides);\n\n// TData = Partial\n// TResult = Data\n\nconsole.log({ merged });\n```\n\nOutput\n\n```json\n{\n \"merged\": {\n \"name\": \"object-deep-merge\",\n \"description\": \"merge objects, deeply\"\n }\n}\n```\n\n\n\n### Simple Example w/ `TData` and `TResult` Generics\n\n> [!NOTE]\n> Passing in `TResult` will override the output type. While this should be used sparingly, it provides a convenient approach for correctly typing partial types into complete types.\n\n```ts\ntype Data = {\n name: string;\n description: string;\n};\n\nconst base: Data = { name: \"object-deep-merge\", description: \"merge objects\" };\n\nconst overrides: Partial = { description: \"merge objects, deeply\" };\n\nconst merged: Data = merge, Data>(base, overrides);\n\n// TData = Partial\n// TResult = Data\n\nconsole.log({ merged });\n```\n\nOutput\n\n```json\n{\n \"merged\": {\n \"name\": \"object-deep-merge\",\n \"description\": \"merge objects, deeply\"\n }\n}\n```\n\n\n","readmeFilename":"README.md"}
![\"Object](\"https://pqt.s3.ca-central-1.amazonaws.com/object-deep-merge/assets/images/logos/dark.png\")
\n![\"Forcir](\"https://cdn.forcir.com/oss/forcir-object-deep-merge/assets/images/logos/light.png\")
\n