{"id":20068669,"url":"https://github.com/radarsu/options-defaults","last_synced_at":"2025-07-13T19:40:11.425Z","repository":{"id":40341074,"uuid":"278157124","full_name":"radarsu/options-defaults","owner":"radarsu","description":"TypeScript Options / Defaults / Overrides Pattern implementation better than Object.assign, destructing or lodash _.merge.","archived":false,"fork":false,"pushed_at":"2024-09-24T15:27:52.000Z","size":36,"stargazers_count":6,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-21T01:14:18.829Z","etag":null,"topics":["defaults","design-pattern","options","ts","typescript"],"latest_commit_sha":null,"homepage":"","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/radarsu.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":null,"security":null,"support":null}},"created_at":"2020-07-08T17:49:08.000Z","updated_at":"2025-05-05T21:43:42.000Z","dependencies_parsed_at":"2023-01-24T06:31:00.914Z","dependency_job_id":null,"html_url":"https://github.com/radarsu/options-defaults","commit_stats":null,"previous_names":["radarsu/ts-options-defaults"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/radarsu/options-defaults","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radarsu%2Foptions-defaults","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radarsu%2Foptions-defaults/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radarsu%2Foptions-defaults/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radarsu%2Foptions-defaults/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/radarsu","download_url":"https://codeload.github.com/radarsu/options-defaults/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radarsu%2Foptions-defaults/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265197428,"owners_count":23726424,"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":["defaults","design-pattern","options","ts","typescript"],"created_at":"2024-11-13T14:08:05.335Z","updated_at":"2025-07-13T19:40:11.379Z","avatar_url":"https://github.com/radarsu.png","language":"TypeScript","funding_links":["https://www.buymeacoffee.com/radarsu"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ch1\u003eoptions-defaults\u003c/h1\u003e\n    \u003cdiv\u003eOptions-defaults design pattern implementation for reliable configuration. It merges objects deeply, overrides arrays and classes (different than Object) and the result remains strongly typed.\u003c/div\u003e\n\u003c/p\u003e\n\n[![\"Buy Me A Coffee\"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/radarsu)\n\n## Table of contents\n\n1. [Getting Started](#getting-started)\n\n2. [Usage](#usage)\n\n3. [Features](#features)\n\n\n\n## Getting Started\n`npm i options-defaults`\n\n\n## Usage\n### Design pattern - OOP way\n\n```ts\nimport { defaults } from 'options-defaults';\n\nexport interface SomeOptions {\n    logger?: Partial\u003cConsole\u003e;\n}\n\nexport class Something {\n    static defaults = {\n        logger: console,\n    };\n\n    options: SomeOptions \u0026 typeof Something.defaults;\n    constructor(options?: SomeOptions) {\n        this.options = defaults(Something.defaults, options);\n    }\n}\n```\n\n### Design pattern - Functional way\n\n```ts\nimport { defaults } from 'options-defaults';\n\nexport interface SomeOptions {\n    logger?: Partial\u003cConsole\u003e;\n}\n\nconst somethingDefaults = {\n    logger: console,\n};\n\nexport const doSomething = (options: SomeOptions) =\u003e {\n    const config = defaults(somethingDefaults, options);\n};\n```\n\n### Behavior\n\n```ts\nimport { defaults } from 'options-defaults';\n\nclass TestLogger {\n    constructor(public name = `TestLogger`) {}\n\n    log() {\n        console.log(`Call from ${this.name}`);\n    }\n}\n\nconst someDefaults = {\n    console,\n    nested: {\n        property: 'default',\n        shouldBeDefault: 'default',\n        array: ['default1', 'default2'],\n    },\n};\n\nconst someOptions = {\n    nested: {\n        property: 'overriden',\n        array: ['overriden1'],\n    },\n    array: ['overriden'],\n};\n\nconst options = defaults(\n    someDefaults,\n    someOptions,\n    {\n        console: {\n            log: () =\u003e {\n                console.log(`TEST`);\n            },\n        },\n    },\n    {\n        console: new TestLogger(),\n    },\n);\n\noptions.console.log(`log`); // \"Call from TestLogger\"\noptions.console.debug(`debug`); // \"debug\"\n\n// options will be:\n{\n    \"nested\": {\n        \"property\": \"overriden\",\n        \"shouldBeDefault\": \"default\",\n        \"array\": [\n            \"overriden1\"\n        ]\n    },\n    \"array\": [\n        \"overriden\"\n    ]\n}\n\n// someDefaults will not be mutated!\n```\n\n\n## Features\n-   **Beats alternatives** - better alternative to `{...defaults, ...options}` destructing and lodash `_.defaults` or `_.merge`\n-   **Secure** - immune to prototype pollution attack\n-   **Simple** - just 40 lines of clean TypeScript code\n-   **Strongly typed** - result remains strongly typed\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fradarsu%2Foptions-defaults","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fradarsu%2Foptions-defaults","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fradarsu%2Foptions-defaults/lists"}