Keep an array of objects indexed by field, for super-fast retrieval.
Have you ever created an array, filled it with objects, and then wanted to sometimes
retrieve the objects based on "id", but sometimes based on "slug"? Did you simple
find(key, value) method? That's okay, I've done it too. Just keep reading
though, you'll love this module.
Reol lets you create an array of objects pretty much like you've always done, but you can also specify fields to be indexed. The advantage of indexes is that retrieving an object based on the value of an indexed field is a lot faster.
In short, this module is ideal when you have a lot of objects which you want to find based on some keys, where the indexed values do not change and elements do not need to be removed.
As you can see, Reol's strength is when you're reading more than writing.
make benchmark to test yourself on your own machine or check out
this jsperf test for fancy graphs.
npm install reol -S
var Reol = require('reol'); // To use in scripts
bower install reol
dist/reol.min.js and put it where you like it. Reol should work in
all js environments, including commonJS (node) and AMD (requireJS) as well as
Create an instance
// Arrayvar array = ;// Reolvar list =test: true'parent.child': true // Supports deep indexing;
Create and add a bunch of elements at the same time
// Arrayvar array = obj1 obj2 obj3;// Reolvar list =test: true'parent.child': true // Supports deep indexing;
Add an element
// Arrayarray;// Reollist; // Chain adds if you feel like, just 'cause you can
Indexing works even with undefined and complex values, though the latter is not recommended. If you want to index objects, implement a custom .toString method, or they will all be treated as the same value.
list;// Un-indexed fields also worklist;// Find all matcheslist;// findOne will speed up best-case scenarios for queries on un-indexed fieldslist;
Searching on multiple fields is not allowed. Use filtering instead.
// By matching an objectlist;// By supplying your own comparison function, .filter() stylelist;
You can copy lists using clone
var newList = list;var evenNewer = newList;
Removing elements working since 0.3.
// First find or filter out the unwanted elements, the .remove() themlist;// Or supply a collection of elementslist;// Note that this removes the element(s) from the parent element (eg "list")// Create a new instance with .clone() to remove elements from only that setlist;
You can also use the following regular array-methods:
These are reimplemented as close to the native ones as possible. Accessor methods returns the element (or an instance of Reol.List in case of multiple elements) while mutator methods returns itself so it can be chained (unless it's supposed to return a result of course). All other methods are left with the native implementation and should work but are not tested.
Ordered somewhat by simpleness and likelihood of being implemented.
I just threw this together in a few hours to solve my problem at hand. If you want to pick something on the todo list or have an opinion on how some method should be implemented (or maybe not implemented at all), please don't hestitate to create an issue, submit a pull request, tweet/email me or whatever.
For example I'm at the moment not sure if I should keep Reol as a very small and basic utility or extend it with rather complex (but some might argue essential) functionality such as .remove() and advanced indexing.
When contributing, please take care to maintain the current coding style and add tests for any added/changed functionality, and issue the pull-request to the develop branch from your own feature-branch. Also avoid unnecessary merges, it's just ugly.
make test to test.