Package Exports

object-set-all-values-to

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (object-set-all-values-to) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

object-set-all-values-to

Recursively walk the input and set all found values in plain objects to something

Install
Purpose
Use
API
Contributing
Licence

Install

npm i object-set-all-values-to

// consume as a CommonJS require:
const setAllValuesTo = require('object-set-all-values-to')
// or as an ES Module:
import setAllValuesTo from 'object-set-all-values-to'

Here's what you'll get:

Type	Key in `package.json`	Path	Size
Main export - CommonJS version, transpiled to ES5, contains `require` and `module.exports`	`main`	`dist/object-set-all-values-to.cjs.js`	2 KB
ES module build that Webpack/Rollup understands. Untranspiled ES6 code with `import`/`export`.	`module`	`dist/object-set-all-values-to.esm.js`	1 KB
UMD build for browsers, transpiled, minified, containing `iife`'s and has all dependencies baked-in	`browser`	`dist/object-set-all-values-to.umd.js`	11 KB

⬆ back to top

Purpose

Take any input: nested array, nested plain object or whatever really, no matter how deeply nested. Walk through it recursively and if you find any plain objects, assign all their keys to a given second input's argument OR default, false.

It does not mutate the input arguments. Operations are done on a cloned input.

I needed this library to overwrite all values to be false on JSON schema objects, so that later when I copy from key/value pairs from schema, values are equal to false and I don't need to prep them further.

This library is well-tested and is being used in commercial projects.

⬆ back to top

Use

const setAllValuesTo = require('object-set-all-values-to')

console.log(setAllValuesTo({a: 'b', c: 'd'}))
// => {a: false, c: false}

console.log(setAllValuesTo({a: 'b', c: 'd'}, 'x'))
// => {a: 'x', c: 'x'}

console.log(setAllValuesTo({a: 'b', c: 'd'}, ['x']))
// => {a: ['x'], c: ['x']}

⬆ back to top

API

setAllValuesTo(input, value)

API - Input

Input argument	Type	Obligatory?	Default	Description
`input`	Whatever	yes	`undefined`	AST tree, or object or array or whatever. Can be deeply-nested. Hopefully contains some plain objects.
`value`	Whatever	no	`false`	Assign all the found plain object values to this

⬆ back to top

API - Output

Same thing that you gave in the first argument, except with values overwritten (where applicable).

Contributing

Hi! 99% of people in the society are passive - consumers. They wait for others to take action, they prefer to blend in. The remaining 1% are proactive citizens who will do something rather than wait. If you are one of that 1%, you're in luck because I am the same and together we can make something happen.

If you want a new feature in this package or you would like to change some of its functionality, raise an issue on this repo. Also, you can email me. Just let it out.
If you tried to use this library but it misbehaves, or you need an advice setting it up, and its readme doesn't make sense, just document it and raise an issue on this repo. Alternatively, you can email me.
If you don't like the code in here and would like to give advice about how something could be done better, please do. Same drill - GitHub issues or email, your choice.
If you would like to add or change some features, just fork it, hack away, and file a pull request. I'll do my best to merge it quickly. Code style is airbnb-base, only without semicolons. If you use a good code editor, it will pick up the established ESLint setup.

⬆ back to top

Licence

MIT License (MIT)