@novigi/array
Extending the Javascript Array operations to make objects handling a lot simpler
πΏ Features
- Modify object arrays to contain only the given keys
- Modify object arrays to remove the keys provided
- Convert object arrays to JSON String
- Modify object arrays to filter elements with unique keys
π¦ Getting Started
- Install the dependency
npm install @novigi/array
- Import the library
const lib = require('@novigi/array');
π Documentation
array
Extending the Javascript Array operations to make objects handling a lot simpler
require('@novigi/array');
[{id: 1, name: 'UserA', age: 33}, {id: 2, name: 'UserB', age: 32}].include(['id', 'name']) // [{"id": 1, "name": "UserA"}, {"id": 2, "name": "UserB"}]
[{id: 1, name: 'UserA', age: 33}, {id: 2, name: 'UserB', age: 32}].exclude(['age']) // [{"id": 1, "name": "UserA"}, {"id": 2, "name": "UserB"}]
Chainable + immutable methods!
-
array
-
~Array
-
.include(inclusions) β
Array
-
.exclude(exclusions) β
Array
-
.flatten() β
Array
-
.toJson() β
String
-
.unique(property) β
Array
-
.include(inclusions) β
-
~Array
array~Array
Extension methods for built in Array object. Most of these methods are returning a new Array object so the API is immutable and chainable.
Kind: inner external of array
Example
new Array().include(['key1', 'key2'])
new Array().exclude(['key1', 'key2'])
-
~Array
-
.include(inclusions) β
Array
-
.exclude(exclusions) β
Array
-
.flatten() β
Array
-
.toJson() β
String
-
.unique(property) β
Array
-
.include(inclusions) β
Array
array.include(inclusions) β Extension method for Array of objects to preserve only given keys
Kind: instance method of Array
Returns: Array
- an array of objects after filtering inclusions
Param | Type | Description |
---|---|---|
inclusions | Array |
an array of strings indicating the keys to preserve |
Example
[{id: 1, name: 'UserA', age: 33}, {id: 2, name: 'UserB', age: 32}].include(['id', 'name']) // [{"id": 1, "name": "UserA"}, {"id": 2, "name": "UserB"}]
Array
array.exclude(exclusions) β Extension method for Array of objects to eliminate given keys
Kind: instance method of Array
Returns: Array
- an array of objects after filtering exclusions
Param | Type | Description |
---|---|---|
exclusions | Array |
an array of strings indicating the keys to remove |
Example
[{id: 1, name: 'UserA', age: 33}, {id: 2, name: 'UserB', age: 32}].exclude(['age']) // [{"id": 1, "name": "UserA"}, {"id": 2, "name": "UserB"}]
Array
array.flatten() β Extension method for flattening the object array in to singleβdepth object array
Kind: instance method of Array
Returns: Array
- an array after flattening
Example
[{ name: 'test', address: { personalId: 3, office: { buildingExists: true, street: 'some street' } } }].flatten() // [{ name: 'test', address_personalId: 3, address_office_buildingExists: true, address_office_street: 'some street' }]
[{ name: 'test', address: { street: ['some', 'street'] } }].flatten() // [{ name: 'test', address_street_0: 'some', address_street_1: 'street' }]
String
array.toJson() β Extension method for return a JSON String version of an array object
Kind: instance method of Array
Returns: String
- JSON String after converting array object
Example
[{id: 1, name: 'UserA', age: 33}, {id: 2, name: 'UserB', age: 32}].toJson() // '[{"id":1,"name":"UserA","age":33},{"id":2,"name":"UserB","age":32}]'
Array
array.unique(property) β Extension method for filter array elements with unique keys
Kind: instance method of Array
Returns: Array
- an array after filter elements with unique keys
Param | Type | Description |
---|---|---|
property | Array |
an array of strings indicating the keys to unique values |
Example
[ {id: 1, name: "UserA", age: 33}, {id: 2, name: "UserA", age: 32}, {id: 3, name: "UserC", age: 31} ].unique('name') // [ {id: 1, name: "UserA", age: 33}, {id: 3, name: "UserC", age: 31} ]
This is an auto generated file. Please don't make changes manually