array-member
Javascript module to test for array/object membership.
Installation
Add to a node project:
npm install array-member --save
Usage
Test whether an object is a member of an array:
var arrMember = ;var myArr = "a""b""c""e";// prints "true":console;// prints "false":console;
Test whether a string is a key for an object:
var arrMember = ;var myObj = abc:123 test:"success" hello:"world";// prints "true":console;// prints "false":console;
Test whether an object is a value in another object:
var arrMember = ;var myObj = abc:123 test:"success" hello:"world";// logs "true":console;// logs "false":console;// logs "true":console;// logs "false":console;// logs "true":console;
API
This module consists of three functions:
arrMember.member(item, array)
returnstrue
ifitem
is inarray
, and returnsfalse
otherwise.arrMember.objectKey(key, obj)
returnstrue
ifkey
is the name of a property inobj
, and returnsfalse
otherwise.arrMember.objectValue(value, obj[, kind='full', caseSensitive=true])
returnstrue
ifvalue
is the value of a property inobj
, and returnsfalse
otherwise.
Options
kind
: optional. Whethervalue
/key
/item
should match the entire item ('full'
), the beginning ('begins'
), or any portion ('contains'
). Defaults to'full'
.caseSensitive
: optional, logical. Whether matching should be case-sensitive or not. Defaults totrue
.
Changelog
1.2.x
- Add options to all functions.
- Changes to arrangement of module.
- Fix typo.
- Tidy code.
1.1.x
Add options for type of matching and case-sensitivity to objectValue()
.
License
This module is licensed under the terms of the MIT License, Copyright (c) 2016 R Steiner