recordarray
v0.0.9
Published
Array Class Extension for Records
Downloads
4
Maintainers
Readme
RecordArray
Zero Dependency Extension of Javascript Array class with record data handling capabilities
Note: Further information on recordarray.js.ie or recordarray.com
Installation
npm install recordarray
Usage:
const RecordArray = require('recordarray');
const users = new RecordArray([
{id: 1, name: 'Admin', type: 'admin'},
{id: 2, name: 'Bob', type: 'guest'},
{id: 3, name: 'Sam', type: 'guest'}
]);
console.log( 'User with ID 1 = ', users.findOneByID(1).name );
// Output: "Admin"
console.log( 'Guest Users Reverse Alphabetically = ', users
.findBy('type', 'guest')
.sortBy('name','DESC')
.listValues('name')
.join(', ')
);
// Output: "Sam, Bob"
class methods
- compare
- compareRecords
compare
compareRecords
object methods
As this class extends the base Array class it inherits all methods from that class, but may need these alternatives to work with an array of records via their fields.
Retrieval methods
Record Retrieval
- findBy
- findByID
- findByTag
- findOne
- findOneByID
- findOneByTag
- matchBy
- matchByID
- matchByTag
- unique
- uniqueBy
- clone
- toArray
- listValues
- getName
- getNameByTag
- indexBy
- indexByID
- indexByTag
Mutation methods
- sortBy
- sortASC
- sortDESC
- extend
- merge
CRUD methods
- create
- read
- update
- delete
- list