# proxy-object-defaults

> A simplified abstraction for nested defaults on objects, using ES6 Proxies.

Latest version **1.1.0** (published 2018-07-06) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install proxy-object-defaults
pnpm add proxy-object-defaults
yarn add proxy-object-defaults
bun add proxy-object-defaults
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2018-07-06 |
| First published | 2018-07-06 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 181 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | liamzebedee |
| Maintainers | liamzebedee |
| Keywords | es6, defaults, proxies |

## Links

- npm: https://www.npmjs.com/package/proxy-object-defaults
- Repository: https://github.com/liamzebedee/proxy-object-defaults
- Homepage: https://github.com/liamzebedee/proxy-object-defaults#readme
- Issues: https://github.com/liamzebedee/proxy-object-defaults/issues
- npm.io page: https://npm.io/package/proxy-object-defaults

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.17.10

## Recent versions

- 1.1.0 (latest) — 2018-07-06

## README

proxy-object-defaults
=====================

Makes nested JS objects easier to reason with. An experiment in using ES6 proxies (for fun and profit).

## Install
`yarn add proxy-object-defaults`

## Example
```javascript
import proxyDefaults from 'proxy-object-defaults';

const DEFAULT = {
    filter: {
        showTimes: false,
        maxItems: 10
    }
}

let userSettings = {
    filter: {
        maxItems: 20
    }
}

let settings = proxyDefaults(userSettings, DEFAULT);
console.log(settings.filter);
// filter: {
//     showTimes: false,
//     maxItems: 20
// }

console.log(settings)
// filter: {
//    maxItems: 20
// }

delete settings.filter;
console.log(settings)
// {}
```

## Usage
`proxyDefaults(obj, defaults, deepClone=true)`

---
_Source: https://npm.io/package/proxy-object-defaults · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._