arry-array

arRy

arRy is a modular and lightweight ES6 array library to simplify array modification operations.

Installation

Pull it in through npm or yarn:

npm install arry-array

yarn add arry-array

Usage

Sort items

Sort items in array by defined property.

sortItems(array, property)

Example

import { sortItems } from 'arry-array';

const arr = [
    { "id": 1, "name": "Max Mustermann"},
    { "id": 4, "name": "Karla Kulunder"},
    { "id": 3, "name": "Moritz Pauls" },
    { "id": 2, "name": "Franka Frank" }
]

sortItems(arr, 'id');

console.log(arr);
/*
[
    { "id": 1, "name": "Max Mustermann" },
    { "id": 2, "name": "Franka Frank" },
    { "id": 3, "name": "Moritz Pauls" },
    { "id": 4, "name": "Karla Kulunder"}
]
*/

Remove item

Remove item from array by defined value of property.

removeItem(array, property, value)

Example

import { removeItem } from 'arry-array';

const arr = [
    { "id": 1, "name": "Max Mustermann"},
    { "id": 2, "name": "Karla Kulunder"},
    { "id": 3, "name": "Moritz Pauls" },
    { "id": 4, "name": "Franka Frank" }
]

removeItem(arr, 'id', 3);

console.log(arr);
/*
[
    { "id": 1, "name": "Max Mustermann" },
    { "id": 2, "name": "Karla Kulunder" },
    { "id": 4, "name": "Franka Frank"  }
]
*/

Insert item

Insert new item at defined array index.

insertItem(array, index, ...items)

Example

import { insertItem } from 'arry-array';

const arr = [
    { "id": 1, "name": "Max Mustermann" },
    { "id": 2, "name": "Karla Kulunder" }
]

insertItem(arr, 1, {"id": 3, "name": "Moritz Pauls"});

console.log(arr);
/*
[
    { "id": 1, "name": "Max Mustermann" },
    { "id": 3, "name": "Moritz Pauls" },
    { "id": 2, "name": "Karla Kulunder" }
]
*/

Get item in array by property value

Get item from by defined property value.

getItem(array, property, value)

Example

import { getItem } from 'arry-array';

const arr = [
    { "id": 1, "name": "Max Mustermann" },
    { "id": 2, "name": "Karla Kulunder" },
    { "id": 3, "name": "Moritz Pauls" }
]

getItem(arr, 'id', 2);

console.log(arr);
/*
[
    { "id": 2, "name": "Karla Kulunder" }
]
*/

Update item in array by property value

Update item in array, find by property value.

updateItemProp(array, property, value, propertyToUpdate, data)

Example

import { updateItemProp } from 'arry-array';

const arr = [
    { "id": 1, "name": "Max Mustermann" },
    { "id": 2, "name": "Karla Kulunder" },
    { "id": 3, "name": "Moritz Pauls" }
]

updateItemProp(arr, 'id', 2, 'name', 'Martin Augustus');

console.log(arr);
/*
[
    { "id": 1, "name": "Max Mustermann" },
    { "id": 2, "name": "Martin Augustus" },
    { "id": 3, "name": "Moritz Pauls" }
]
*/

Get duplicate items in array by property

Get all duplicate items from array by property value.

getDuplicates(array, property)

Example

import { getDuplicates } from 'arry-array';

const arr = [
    { "id": 1, "name": "Max Mustermann" },
    { "id": 2, "name": "Karla Kulunder" },
    { "id": 3, "name": "Moritz Pauls" },
    { "id": 2, "name": "Max Meier" },
]

getDuplicates(arr, 'id');

console.log(arr);
/*
[
    { "id": 2, "name": "Karla Kulunder" },
    { "id": 2, "name": "Max Meier" }
]
*/

Remove duplicate items in array by property

Remove all duplicate items from array by property value, except the first one.

removeDuplicate(array, property)

Example

import { removeDuplicate } from 'arry-array';

const arr = [
    { "id": 1, "name": "Max Mustermann" },
    { "id": 2, "name": "Karla Kulunder" },
    { "id": 3, "name": "Moritz Pauls" },
    { "id": 2, "name": "Max Meier" },
]

removeDuplicate(arr, 'id');

console.log(arr);
/*
[
    { "id": 1, "name": "Max Mustermann" },
    { "id": 2, "name": "Karla Kulunder" },
    { "id": 3, "name": "Moritz Pauls" },
]
*/

Filter array by multiple properties

Get all items from array by multiple property values.

filterItems(array, property)

Example

import { filterItems } from 'arry-array';

const arr = [
    { "id": 1, "name":"Mark", "city": "Mannheim", "age": "21" },
    { "id": 2, "name":"Kathrin", "city": "Berlin", "age": "49" },
    { "id": 3, "name":"Frank", "city": "Mannheim", "age": "21" },
    { "id": 4, "name":"Max", "city": "Frankfurt", "age": "38" },
    { "id": 5, "name":"Lisa", "city": "Mannheim", "age": "23" },
]

filterItems(arr, { city: "Mannheim", age: "21" });

console.log(arr);
/*
[
    { "id": 1, "name":"Mark", "city": "Mannheim", "age": "21" },
    { "id": 3, "name":"Frank", "city": "Mannheim", "age": "21" },
]
*/

More usefull functions coming soon :)

Copyright (c) 2019 fabian bentz. Released under the MIT license.