{"id":25177489,"url":"https://github.com/forcir/object-deep-merge","last_synced_at":"2025-05-07T01:49:37.185Z","repository":{"id":187557640,"uuid":"668145716","full_name":"forcir/object-deep-merge","owner":"forcir","description":"Strongly-typed deep and recursive object merging with support for all value types.","archived":false,"fork":false,"pushed_at":"2023-11-13T03:06:35.000Z","size":373,"stargazers_count":2,"open_issues_count":7,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-27T15:48:43.897Z","etag":null,"topics":["deep-merge","deep-merge-object","deep-merge-objects","deep-merging","merge-object","merge-objects","merge-options","object-deep-merge","object-deep-merging","object-merge","object-merging","type-safe","typesafe","typescript","typescript-library"],"latest_commit_sha":null,"homepage":"https://npmjs.com/object-deep-merge","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/forcir.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-19T06:13:00.000Z","updated_at":"2024-03-27T20:07:49.000Z","dependencies_parsed_at":"2024-09-02T13:01:08.753Z","dependency_job_id":null,"html_url":"https://github.com/forcir/object-deep-merge","commit_stats":{"total_commits":17,"total_committers":2,"mean_commits":8.5,"dds":0.05882352941176472,"last_synced_commit":"4aec7fd2b67b4723f696db3bae144d90cdf5623d"},"previous_names":["forcir/object-deep-merge"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forcir%2Fobject-deep-merge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forcir%2Fobject-deep-merge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forcir%2Fobject-deep-merge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forcir%2Fobject-deep-merge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/forcir","download_url":"https://codeload.github.com/forcir/object-deep-merge/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252798781,"owners_count":21805880,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deep-merge","deep-merge-object","deep-merge-objects","deep-merging","merge-object","merge-objects","merge-options","object-deep-merge","object-deep-merging","object-merge","object-merging","type-safe","typesafe","typescript","typescript-library"],"created_at":"2025-02-09T14:25:30.541Z","updated_at":"2025-05-07T01:49:37.147Z","avatar_url":"https://github.com/forcir.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003c/p\u003e\n\u003cdiv align=\"center\"\u003e\n    \u003cpicture\u003e\n        \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://cdn.forcir.com/oss/forcir-object-deep-merge/assets/images/logos/dark.png\" height=\"64\"\u003e\n        \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://cdn.forcir.com/oss/forcir-object-deep-merge/assets/images/logos/light.png\" height=\"64\"\u003e\n        \u003cimg alt=\"Forcir Object Deep Merge Logo\" src=\"https://cdn.forcir.com/oss/forcir-object-deep-merge/assets/images/logos/light.png\" height=\"64\"\u003e\n    \u003c/picture\u003e\n\u003c/div\u003e\n\u003cp align=\"center\"\u003e\u003cstrong\u003eStrongly-typed deep and recursive object merging with support for all value types.\u003c/strong\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003c/p\u003e\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\n\u003cdetails\u003e\u003csummary\u003eOutput\u003c/summary\u003e\n\n```json\n{\n    \"merged\": {\n        \"foo\": false,\n        \"bar\": true\n    }\n}\n```\n\n\u003c/details\u003e\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\u003cTData extends MergeableObject = MergeableObject, TResult extends MergeableObject = TData\u003e(\n    source: TData,\n    target: TData,\n    ...targets: Array\u003cTData\u003e\n): TResult;\n```\n\n\u003e [!IMPORTANT]  \n\u003e 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 shipped from this library as a convenience. It is not unreasonable to use those types directly instead.\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\u003cData\u003e = { description: \"merge objects, deeply\" };\n\nconst merged = merge(base, overrides);\n\n// Type is inferred so the signature becomes:\n// function merge\u003cPartial\u003cData\u003e, Partial\u003cData\u003e\u003e(source: Partial\u003cData\u003e, target: Partial\u003cData\u003e, ...targets: Partial\u003cData\u003e[]): Partial\u003cData\u003e\n\n// TData    = Partial\u003cData\u003e\n// TResult  = Data\n\nconsole.log({ merged });\n```\n\n\u003cdetails\u003e\u003csummary\u003eOutput\u003c/summary\u003e\n\n```json\n{\n    \"merged\": {\n        \"name\": \"object-deep-merge\",\n        \"description\": \"merge objects, deeply\"\n    }\n}\n```\n\n\u003c/details\u003e\n\n### Simple Example w/ `TData` Generic\n\n\u003e [!NOTE]\n\u003e 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\u003cData\u003e = { description: \"merge objects, deeply\" };\n\nconst merged: Partial\u003cData\u003e = merge\u003cPartial\u003cData\u003e\u003e(base, overrides);\n\n// TData    = Partial\u003cData\u003e\n// TResult  = Data\n\nconsole.log({ merged });\n```\n\n\u003cdetails\u003e\u003csummary\u003eOutput\u003c/summary\u003e\n\n```json\n{\n    \"merged\": {\n        \"name\": \"object-deep-merge\",\n        \"description\": \"merge objects, deeply\"\n    }\n}\n```\n\n\u003c/details\u003e\n\n### Simple Example w/ `TData` and `TResult` Generics\n\n\u003e [!NOTE]\n\u003e 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\u003cData\u003e = { description: \"merge objects, deeply\" };\n\nconst merged: Data = merge\u003cPartial\u003cData\u003e, Data\u003e(base, overrides);\n\n// TData    = Partial\u003cData\u003e\n// TResult  = Data\n\nconsole.log({ merged });\n```\n\n\u003cdetails\u003e\u003csummary\u003eOutput\u003c/summary\u003e\n\n```json\n{\n    \"merged\": {\n        \"name\": \"object-deep-merge\",\n        \"description\": \"merge objects, deeply\"\n    }\n}\n```\n\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforcir%2Fobject-deep-merge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fforcir%2Fobject-deep-merge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforcir%2Fobject-deep-merge/lists"}