Array-member NPM

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 = require('array-member');
var myArr = ["a","b","c","e"];
// prints "true":
console.log(arrMember.member("a", myArr));
// prints "false":
console.log(arrMember.member("d", myArr));

Test whether a string is a key for an object:

var arrMember = require('array-member');
var myObj = {
    abc:123,
    test:"success",
    hello:"world"
};
// prints "true":
console.log(arrMember.objectKey("abc", myObj));
// prints "false":
console.log(arrMember.objectKey("def", myObj));

Test whether an object is a value in another object:

var arrMember = require('array-member');
var myObj = {
    abc:123,
    test:"success",
    hello:"world"
};
// logs "true":
console.log(arrMember.objectValue("success", myObj));
// logs "false":
console.log(arrMember.objectValue("foo", myObj));
// logs "true":
console.log(arrMember.objectValue("ess", myObj, kind="contains"));
// logs "false":
console.log(arrMember.objectValue("ess", myObj, kind="begins"));
// logs "true":
console.log(arrMember.objectValue("WORLD", myObj, caseSensitive=false));

API

This module consists of three functions:

arrMember.member(item, array) returns true if item is in array, and returns false otherwise.
arrMember.objectKey(key, obj) returns true if key is the name of a property in obj, and returns false otherwise.
arrMember.objectValue(value, obj[, kind='full', caseSensitive=true]) returns true if value is the value of a property in obj, and returns false otherwise.

Options

kind: optional. Whether value/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 to true.