khas
v1.0.0
Published
Checks for the existence of one or more keys in a Map, Object, or other collection. Supports nesting, loose key matching, and more.
Downloads
3
Maintainers
Readme
khas
Checks for the existence of one or more keys 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 khas
API
The module exports a function (has()
) that has other functions attached to it as methods (e.g. has.any()
).
has()
Parameters
- Bindable:
collection
(Array, iterator, Map, Object, Set, string, Typed Array, or WeakMap): The key-value collection from which to retrieve a value. keychain
(any, or array of any): A key to check, or an array of nested keys.- 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).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).inObj
(boolean): Whether or not to search inherited properties ifcollection
is an Object (i.e. not another recognized type). Defaults tofalse
.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.
Return Value
Returns true
if a value exists at the location indicated by keychain
, otherwise false
.
Example
const has = require('khas')
const map = new Map()
map.set('mapKey', {objKey: 'string'})
has(map, ['mapKey', 'objKey']) // true
has.any()
Has the same signature as the main function, except that the second parameter is called keychains
and expects an array of keys or keychain arrays. Returns true
if at least one of them points to a value, otherwise false
.
Example
const has = require('khas')
has.any({c: 3, d: 4}, [['a', 'subkey'], 'b', 'c']) // true
The function tries the keys a.subkey
, b
, and c
in that order. Since there is a value located at c
, the function returns true
.
has.in()
This method is an alias for calling the main has()
method with the inObj
option set to true
.
has.any.in()
This method is an alias for calling has.any()
with the inObj
option set to true
.
Related
The “k” family of modules works on keyed/indexed collections.
The “v” family of modules works on any collection of values.