README

SimpleLists

Simple functions for object arrays/lists in JavaScript

Installation

Via npm on Node:

npm install simplelists

You can include lib/simplelists.js directly into your HTML page. It declares the sl namespace.

Usage

Reference in your Node.js program:

var sl = require('simplelists');

Given an array of objects:

var list = [
    { id: 1, name: 'Adam', age: 800, gender: 'man' },
    { id: 2, name: 'Eve', age: 600, gender: 'woman' },
    { id: 3, name: 'Abel', age: 500, gender: 'man' },
    { id: 4, name: 'Caine', age: 400, gender: 'man' }
];

Retrieve some fields:

var result = sl.project(list, ['id', 'name']);

Retrieve only one fields:

var result = sl.project(list, 'name');

Filter using query by example:

var result = sl.where(list, { gender: 'man' });

Remove repeated values:

var result = sl.unique(list, 'gender'); // Adam, Eve objects

Take:

var result = sl.take(list, 2); // Adam, Eve

Shuffle:

var result = sl.shuffle(list); // same elements in random order

Given another array of objects:

var list2 = [
    { id: 1, name: 'Adam', age: 800, gender: 'man' },
    { id: 2, name: 'Eve', age: 600, gender: 'woman' },
    { id: 5, name: 'Set', age: 300, gender: 'man' },
    { id: 6, name: 'Sarah', age: 200, gender: 'woman' }
];

Union:

var result = sl.union(list, list2 'gender'); // Adam, Eve, Abel, Caine, Set, Sahara objects

Difference:

var result = sl.diff(list, list2, 'gender'); // Abel, Caine objects

TBD

Development

git clone git://github.com/ajlopez/SimpleLists.git
cd SimpleLists
npm install
npm test

Samples

TBD

Versions

0.0.1 Published
0.0.2 Published, new functions: exist, count, first, ...
0.0.3 Published, fixing package.json
0.0.4 Published, new function: aggr; project with rename
0.0.5 Published, with intersect and all new functions
0.0.6 Published, multicolumn sort
0.0.7 Published, take, shuffle

Contribution

Feel free to file issues and submit pull requests � contributions are welcome.

If you submit a pull request, please be sure to add or update corresponding test cases, and ensure that npm test continues to pass.

Usage no npm install needed!