https://github.com/radarsu/options-defaults
TypeScript Options / Defaults / Overrides Pattern implementation better than Object.assign, destructing or lodash _.merge.
https://github.com/radarsu/options-defaults
defaults design-pattern options ts typescript
Last synced: 12 months ago
JSON representation
TypeScript Options / Defaults / Overrides Pattern implementation better than Object.assign, destructing or lodash _.merge.
- Host: GitHub
- URL: https://github.com/radarsu/options-defaults
- Owner: radarsu
- License: mit
- Created: 2020-07-08T17:49:08.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T15:27:52.000Z (almost 2 years ago)
- Last Synced: 2025-06-21T01:14:18.829Z (about 1 year ago)
- Topics: defaults, design-pattern, options, ts, typescript
- Language: TypeScript
- Homepage:
- Size: 35.2 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
options-defaults
Options-defaults design pattern implementation for reliable configuration. It merges objects deeply, overrides arrays and classes (different than Object) and the result remains strongly typed.
[](https://www.buymeacoffee.com/radarsu)
## Table of contents
1. [Getting Started](#getting-started)
2. [Usage](#usage)
3. [Features](#features)
## Getting Started
`npm i options-defaults`
## Usage
### Design pattern - OOP way
```ts
import { defaults } from 'options-defaults';
export interface SomeOptions {
logger?: Partial;
}
export class Something {
static defaults = {
logger: console,
};
options: SomeOptions & typeof Something.defaults;
constructor(options?: SomeOptions) {
this.options = defaults(Something.defaults, options);
}
}
```
### Design pattern - Functional way
```ts
import { defaults } from 'options-defaults';
export interface SomeOptions {
logger?: Partial;
}
const somethingDefaults = {
logger: console,
};
export const doSomething = (options: SomeOptions) => {
const config = defaults(somethingDefaults, options);
};
```
### Behavior
```ts
import { defaults } from 'options-defaults';
class TestLogger {
constructor(public name = `TestLogger`) {}
log() {
console.log(`Call from ${this.name}`);
}
}
const someDefaults = {
console,
nested: {
property: 'default',
shouldBeDefault: 'default',
array: ['default1', 'default2'],
},
};
const someOptions = {
nested: {
property: 'overriden',
array: ['overriden1'],
},
array: ['overriden'],
};
const options = defaults(
someDefaults,
someOptions,
{
console: {
log: () => {
console.log(`TEST`);
},
},
},
{
console: new TestLogger(),
},
);
options.console.log(`log`); // "Call from TestLogger"
options.console.debug(`debug`); // "debug"
// options will be:
{
"nested": {
"property": "overriden",
"shouldBeDefault": "default",
"array": [
"overriden1"
]
},
"array": [
"overriden"
]
}
// someDefaults will not be mutated!
```
## Features
- **Beats alternatives** - better alternative to `{...defaults, ...options}` destructing and lodash `_.defaults` or `_.merge`
- **Secure** - immune to prototype pollution attack
- **Simple** - just 40 lines of clean TypeScript code
- **Strongly typed** - result remains strongly typed