boolmap
v1.1.1
Published
Hash object for boolean values with extra usefull functions (ES6)
Downloads
14
Maintainers
Readme
BoolMap
Hash object for boolean values with extra usefull functions written in ES6, compiled to ES5
installation
npm install boolmap
Usage
var BoolMap = require('boolmap');
var map = new BoolMap();
map.set('abc', true);
map.get('abc'); //true
API
set(key:string, value:boolean):void
Sets the key
setAll(value:boolean):void
Set all present keys to value
get(key:string):boolean
Get the boolean value of key.
toggle(key:string):void
Toggle the value of key
toggleAll():void
Toggle all keys
isTrue(key:string):boolean
Returns true if the key is true
isFalse(key:string):boolean
Returns true if the key is false
isAnyTrue():boolean
Returns true if at least one key in map is true
isAnyFalse():boolean
Returns true if at least one key in map is false
isAllTrue():boolean
Returns true only if all keys in map are true
isAllFalse():boolean
Returns false only if all keys in map are false
keys():string[]
Returns keys as array of strings
trueKeys():string[]
Returns keys (array of strings) that are true
falseKeys():string[]
Returns keys (array of strings) that are false
Array access
You work with BoolMap as with an array:
var map = new BoolMap();
map.set('abc', true);
expect(map['abc']).toBe(true);