Collection

DESCRIPTION

General

Installation

npm install eden-collection

Usage

var collection = require('eden-collection');

Methods

• add

• cut

• each

• get

• set

---

add

 this add('Elizabeth');

Adds a row to the collection

Parameters

1. 'Elizabeth' - object (string | character | integer | date)

Returns

this

Example

Code

    users.addName('Elizabeth');
    users.addMi('B');
    users.addAge(22);
    users.addBday('September 13, 1992');

users[2].name;
users[2].mi;
users[2].age;
users[2].bday;

Outputs

'Elizabeth'
'B'
22
'September 13, 1992'

---

cut

 this cut(first | 1);

Cut the element from the array based on the index

Parameters

1. first - string - array(collection) position to be cut | 1 - integer - array(collection) position to be cut

Returns

this

Example

Code

    users = collection([
        { name: 'chris1', age: 42 },
        { name: 'chris2', age: 32 },
        { name: 'chase1', age: 22 },
        { name: 'chase2', age: 12 },
        { name: 'chase3', age: 2 }]);

users.cut('first');
users[0].name;
users.cut(1);
users[1].name;
users.cut('last');
users.length;

Outputs

//	cut the first collection - users { name: 'chris1', age: 42 }
'chris2'
//	cut the second collection - users { name: 'chase1', age: 22 }
'chase2'
//	cut the last collection - users { name: 'chase3', age: 2 }
2

---

each

 this each(users[1].getName);

Loops through returned result sets

Parameters

1. users[1].getName() - function (loop to be displayed)

Returns

this

Example

Code

    users.each(function(i, user) {
                user.setName('Something2');
                });

users[1].getName();

Outputs

'Something2'

---

get

 array get(raw[0].name);

Returns the row array

Parameters

1. raw[0].name - function (to be displayed)

Returns

array

Example

Code

    var raw = users.get();

raw[1].age;
raw[0].name;

Outputs

22
'Something2'

---

set

 this set('bobby');

Sets data

Parameters

1. 'bobby' - object (string | character | integer | date) - to be replace in existing data | rename

Returns

this

Example

Code

    users = collection([
        { name: 'chris1', age: 42 },
        { name: 'chris2', age: 32 },
        { name: 'chase1', age: 22 },
        { name: 'chase2', age: 12 },
        { name: 'chase3', age: 2 }]);

    users.setName('bobby');
users[0].name;
users[1].name;
users[2].name;
users[3].name;
users[4].name;

Outputs

'bobby'
'bobby'
'bobby'
'bobby'
'bobby'