objs-collection v0.1.0

Collection

A Collection is an array of objects with a primary key property. It can quantify each item inside collection, motived by shopping cart needed functionalities. It can optionally also trigger an update callback function given as constructor optional argument.

Table of Contents

• Support
• Installation + NPM + Git + Zip
• Usage + Callback + Custom Initial Content
• Plan
• Contribute
• Author

Support

If you need some help or found bug you can open an issue.

Installation

There are some installation ways. You can choose the best way for you.

NPM (recommended)

This way requires NodeJS installed:

$ npm install collection

or using Yarn

$ yarn add collection

Git

Clone the repo into your project:

$ git clone https://github.com/enriquerene/collection.git

Zip

Dowload the package and uncpack it into your project: Dowload ZIP

Usage

Here we cover how to properly use Collection library. Collection identify uniquely each item via primaryKey with default value 'id'. I's possible set whole items list as array of objects via items setter or pushing one object at time via push method. You can set a default quantity for incoming objects. The Collection instance optionally can receive a second argument used as update collection items callback. The default behavior does not include callback, you must pass an one parameter function to constructor. Let's see some examples:

checking-primary-key

The objects must own primaryKey property and have unique values. Use primaryKey to work with:

import Collection from 'collection';

const coll = new Collection();

console.log(coll.primaryKey); // 'id'
coll.primaryKey = 'uniqueKey';
console.log(coll.primaryKey); // 'uniqueKey'

push-one-at-time

Push items into items collection using push.

import Collection from 'collection';

const coll = new Collection();

coll.push({id:1});
coll.push({id:2});
coll.push({id:3});
console.log(coll.items); // [{id:1}, {id:2}, {id:3}]

set-entire-items-list

Set items to the array you want to be the items collection:

import Collection from 'collection';

const coll = new Collection();

coll.items = [{id:1}, {id:2}, {id:3}];
console.log(coll.items); // [{id:1}, {id:2}, {id:3}]

Reset Collection items

Set items to empty array to "clear/reset" collection:

import Collection from 'collection';

const coll = new Collection();

coll.push({id:1});
console.log(coll.items); // [{id:1}]
coll.items = [];
console.log(coll.items); // []

Working with callback

Set a callback and instantiate an Collection object:

import Collection from 'collection';

const updateCallback = (_v) => { console.log(_v) };
const coll = new Collection(updateCallback);

coll.push({id:1}); // console logs '[{id:1}]'

Plan

Some features what are expected for future versions:

• official TypeScript version; Feel free to suggest features for futures versions, just open an issue.

Contribute

If you have something good to share in this project, you are welcome. Just do a pull request with your code.

Author

You can find more projects from Collection's author. Learn more about in (https://enriquerene.com.br)https://enriquerene.com.br.