kset
v2.0.0
Published
Uses one or more keys to locate and set a value in a Map, Object, or other keyed collection. Supports nesting, loose key matching, and more.
Downloads
4
Maintainers
Readme
kset
Uses one or more keys to locate and set a value in a Map, Object, or other collection. Supports nesting, loose key matching, and more.
Installation
Requires Node.js 8.3.0 or above.
npm i kset
API
The module exports an set()
function that has one other function attached to it as a method: set.all()
.
set()
Parameters
- Bindable:
collection
(Array, Map, Object, Set, Typed Array, or WeakMap): The key-value collection with the value to be set. keychain
(any, or array of any): The key at which to setvalue
, or an array of nested keys. If the key or key chain does not exist, it will be created.value
(any): The new value.- Optional: Object argument:
arrays
/maps
/sets
/weakMaps
(arrays of classes/strings): Arrays of classes and/or string names of classes that should be treated as equivalent toArray
/Map
/Set
/WeakMap
(respectively).construct
(function or false): A callback which constructs a new collection in the process of generating a nested key chain that does not already exist. The function is passed a zero-based numeric index indicating the level of nesting, and is expected to return a new collection object. To disable keychain construction altogether, set this tofalse
.elseReturn
(any): A value to return in the event that the set operation was unsuccessful. Only takes effect if noelseThrow
is specified. Defaults toundefined
.elseThrow
(Error or string): An error to be thrown in the event that the set operation was unsuccessful. A string will be wrapped in anError
object automatically.getType
(function): A callback which specifies the type of collection to be created in the process of generating a nested key chain that does not already exist. This callback is only used ifconstruct
is not set. The function is passed a zero-based numeric index indicating the level of nesting and is expected to return a class (Object
,Array
,Map
, etc.) or the string name of a class ('Object'
,'Array'
,'Map'
, etc.). IfgetType
is not specified, thetypes
argument will be used if present.get
(function): A callback which, if provided, will override the built-in code that fetches an individual key from a collection. Use this if you need to support collections whose custom APIs preclude the use of parameters likemaps
. The callback will be called with five arguments: the collection, the key, the options object, the fallback to return if the key is not found, and a callback for the built-in get behavior (to which your customget
callback can defer if it determines that it doesn’t need to override the default behavior after all).loose
(boolean): Whether or not to evaluate keys loosely (as defined bylooselyEquals
). Defaults tofalse
.looselyEquals
(function): A callback that accepts two values and returnstrue
if they are to be considered equivalent orfalse
otherwise. This argument is only used ifloose
istrue
. If omitted, the default behavior will, among other things, consider arrays/objects to be equal if they have the same entries.overwriteAncestors
(boolean): Whether or not to delete non-objects if necessary to resolve thekeychain
. If set tofalse
, then the module will throw an error ifkeychain
references a non-collection. Only applies ifelseThrow
is not set. Defaults tofalse
.overwrite
(boolean): Whether or not to allow an existing value to be replaced withvalue
. Defaults totrue
.preferStrict
(boolean): Only applies ifloose
istrue
. Iftrue
, then strictly-identical keys will be preferred over loosely-equivalent keys. Otherwise, the first loosely-equivalent key found will be used, even if a strictly-identical one comes later. Defaults tofalse
.reverse
(boolean): Set totrue
to use the last matching key instead of the first one. Only applies ifloose
istrue
. Defaults tofalse
.set
(function): A callback which, if provided, will override the built-in code that sets the value of an individual key in a collection. Use this if you need to support collections whose custom APIs preclude the use of parameters likemaps
. The callback will be called with five arguments: the collection, the key, the new value, the options object, and a callback for the built-in set behavior (to which your customset
callback can defer if it determines that it doesn’t need to override the default behavior after all).type
ortypes
(function, string, or array of functions/strings): A class, or its string name, that should be used to construct new collections if a nested key chain does not already exist. To specify different collection types for each level of nesting, put the types into an array. Thetypes
argument is used only ifconstruct
andgetType
are not specified. If neither argument is specified, newly-created nested collections will be of the same type ascollection
.
Return Values
- If no changes took place, returns
elseReturn
if set, otherwiseundefined
. - If setting the value was successful, returns the new value.
Examples
Arrays
const set = require('kset')
const arr = ['a', 'b', 'c']
set(arr, 0, 'A') // 'A'
arr // ['A', 'b', 'c']
Maps
const set = require('kset')
const map = new Map([['key', 'old']])
set(map, 'key', 'new') // 'new'
map.get('key') // 'new'
const nestedMap = new Map()
set(nestedMap, ['key1', 'key2'], 'value') // 'value'
nestedMap.get('key1').get('key2') // 'value'
Objects
const set = require('kset')
const obj = {key1: {}}
set(obj, ['key1', 'key2'], 'value') // 'value'
obj.key1.key2 // 'value'
set.all()
Use this method if you want to set multiple keys to the same value at once.
Parameters
The parameters are the same as the main function, except that the second parameter is called keychains
and accepts an array of keychain
arguments.
Return Value
An array of new values corresponding to the array of keychains. Each element will be the new value if it was set, otherwise elseReturn
or undefined
.
Example
const set = require('kset')
const obj = {a: 1, b: 2, c: 3}
set.all(obj, ['a', 'b'], 0) // [0, 0]
obj.a // 0
obj.b // 0
obj.c // 3
Related
The “k” family of modules works on keyed/indexed collections.
The “v” family of modules works on any collection of values.