Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

localcollection

0.0.3 • Public • Published

localCollection

A Sift.JS wrapper that adds array modification and MongoDB collection-like instantiation for easy access to collections.

MongoDB inspired array filtering

For extended documentation, checkout MongoDB's Docs and Sift.JS

Installation

 
npm install localcollection --save
 
var localCollection = require('localcollection');
 
var Collection = new localCollection( YOUR_ARRAY/OBJECT );
 

Node.js Examples

 
var localCollection = require('localcollection');
 
var someArray = [{id: 1}, {id:2}, {id:3}];
 
var SomeArray = new localCollection(someArray);
 
// Find
SomeArray.find({id:2});
// [ {id:2} ]
 
// FindOne
SomeArray.findOne({id:2});
// {id:2}
 
// Remove
SomeArray.remove({id:2});
// [ {id:1}, {id:3} ]
 
// Count
SomeArray.find({id:3}).count()
// 1
 
// Update
SomeArray.update({id:3}, function(ob){ob.magic = true});
// [ {id:1}, {id:3, magic:true} ]
 
// Insert
SomeArray.insert({yoman: 'guild'});
// [ {id:1}, {id:3, magic:true}, {yoman: 'guild'} ]
 
// FindAndModify
SomeArray.findAndModify({yoman:'guild'}, function(ob){ob.happiness = true});
// [ {yoman:'guild', happiness:true} ]
 

Sift Dependency

This package is a simple wrapper on Sift.js. For more information on functionality and features, see Sift.js

Install

npm i localcollection

DownloadsWeekly Downloads

4

Version

0.0.3

License

ISC

Last publish

Collaborators

  • avatar