basic-collection

basic-collection

A generic collection class to contain array-like data.

Installation

$ npm install basic-collection

Basic usage

import BasicCollection from "basic-collection";

let Collection = new BasicCollection;

Collection.set( "key_1", "value_1" );
Collection.set( "key_2", "value_2" );
Collection.set( 1234567, true );

Collection.get( "key_1" ); // value_1
Collection.get( "key_2" ); // value_2
Collection.get( "key_3", "default" ); // default

Collection.has( "key_1" ); // true
Collection.has( "key_2" ); // true
Collection.has( "key_3" ); // false

Collection.remove( "key_2" );
console.log( Collection.size ); // 2
console.log( Collection.keys ); // [ 'key_1', 1234567 ]
console.log( Collection.values ); // [ 'value_1', true ]
console.log( Collection.entries ); // [ [ 'key_1', 'value_1' ], [ '1234567', 'true' ] ]

Collection.each( ( key, value, map ) => {
    console.log( `Collection[${key}] = ${value}` );
} );

Collection.clear();
console.log( Collection.size ); // 0

Creating custom collections

import BasicCollection from "basic-collection";

class MyCollection {
    constructor( parameters ) {
        super( parameters );
    }

    normalize( key ) {
        return `transformed_${key}`;
    }
}

let Collection = new MyCollection;

Collection.set( "key_1", "value_1" );
Collection.set( "key_2", "value_2" );

console.log( Collection.keys );
// => [ 'transformed_key_1', "transformed_key_2" ]

API

Method	Access	Return
normalize( key )	protected	string
set( key, value )	public	null
get( key[, default] )	public	mixed
has( key )	public	bool
remove( key )	public	null
clear()	public	null
each( callback )	public	null
size	public	int
entries	public	iterable
keys	public	iterable
values	public	iterable