datalist-interface

datalist-interface

A simple interface for a list.

Installation

npm:

npm install datalist-interface

Usage

var DatalistInterface = require('datalist-interface');

var mammals = new DatalistInterface([
    'common vampire bat',
    'virginia opossum',
    'eastern grey kangaroo',
    'tasmanian devil',
    'human',
    'northern elephant seal',
    'fox squirrel',
    'tree pangolin',
    'african elephant',
    'platypus',
    'colugo',
    'reindeer',
    'humpback whale',
    'star-nosed mole',
    'giant panda',
    'giant armadillo',
    'plains zebra',
    'black and rufous elephant shrew'
]);

mammals.is('human'); // true
mammals.is('unicorn'); // false

mammals.add('unicorn').is('unicorn'); // true

mammals.remove('unicorn').is('unicorn'); // false

API

DatalistInterface([value...])

Create a new instance. Values are passed to #add().

Example

var DatalistInterface = require('datalist-interface');

var fish = new DatalistInterface(['shark', 'tuna']);

DatalistInterface#is(value)

DatalistInterface#has(value)

Check if value is in the list.

Example

fish.is('shark'); // true
fish.is('human'); // false

DatalistInterface#add([value...])

Add each value to list.

Example

fish.add('giant grouper', 'red lionfish');

DatalistInterface#remove([value...])

Remove each value from list.

Example

fish.remove('giant grouper', 'reindeer');

DatalistInterface#all()

DatalistInterface#valueOf()

DatalistInterface#toJSON()

Return the list as an Array.

Example

fish.all(); // ['shark', 'tuna', 'red lionfish']

DatalistInterface#toString()

Return the list as a string.

Example

fish.toString(); // 'shark,tuna,red lionfish'

License

MIT © Titus Wormer