like-ar

like-ar

Using objects like arrays with map, filter, forEach and others coming soon.

language: also available in:

Install

$ npm install like-ar

Usage

The function likeAr wraps an object. The wraped object can be used like an array with some array functions: forEach, map, filter y join.

These functions receive a callback in the same way that the array version does.

var likeAr = require('like-ar');

var object={
    lastName:'Perez',
    firstName:'Diego',
    phone:'[phone]'
}

likeAr(object).forEach(function(value, attrName, object){
    console.log(attrName,':',value);
});

console.log(
    likeAr(object).filter(function(value, attrName){
        return attrName.contains('Name');
    }).map(function(value,attrName){
        return attrName+':'+value
    }).join(', ')
);

API

likeAr(object)

The callback functions receive these parameters: value, key and the original object. The functions that in the Array case returns Arrays returns a chainable object.

function	returned value
forEach(cb, this)	undefined
map(cb, this)	chainable object with the same keys and the value mapeds
filter(db, this)	chainable object with the same keys and values for only that key/value that returns true in the callback function
join(separator)	string with the join of the values
array()	array of values
keys()	array of keys
plain()	plain object without likeAr functions

likeAr(object).build(cb(value, key))

Builds a new object with new keys.

The callback function must return a {key: value} object to compose the final result.

var pairs=[{field:'lastName', value:'Perez'}, {field:'firstName', value:'Diego'}];

console.log(likeAr(pairs).build(funciton(pair){ return {[pair.field]: pair.value}; ));
// {lastName: "Perez", firstName: "Diego"}

var toJoin=[{lastName:'Perez'}, {firstName:'Diego'}];

console.log(likeAr(toJoin).build(funciton(objectWithOneKey){ return objectWithOneKey; ));
// {lastName: "Perez", firstName: "Diego"}

likeAr.toPlainObject(array [,keyName [,valueName]])

likeAr.toPlainObject(arrayOfKeys, arrayOfValues)

Returns a plain object from an array of pairs (or a pair of arrays) of key/values.

Default values: 0 and 1 if keyName is not set. "value" for valueName if keyName is set.

Usage

var likeAr = require('like-ar');

var pairs=[['lastName', 'Perez'], ['firstName', 'Diego']];

console.log(likeAr.toPlainObject(pairs));

var pairs=[{field:'lastName', value:'Perez'}, {field:'firstName', value:'Diego'}];

console.log(likeAr.toPlainObject(pairs, 'field'));

likeAr.createIndex(array:T[],keyName:string):{[k:string]: T}

Returns a plain object containing the same element indexed by keyName

Usage

var likeAr = require('like-ar');

var persons=[{name:'Diego', lastName:'Rivera', age:30}, {name:'Frida', lastName:'Kahlo'}];

var idxPersons=likeAr.createIndex(persons, 'lastName');

idxPersons.Kahlo.age=20;

console.log(persons[1].age); // 20

License

MIT