@basekits/kit-array v1.0.0

@basekits/kit-array

Array type helpers kit for basekits.

Install

npm i @basekits/kit-type @basekits/kit-object @basekits/kit-array

Usage

const kit = require('@basekits/core')
const type = require('@basekits/kit-type')
const object = require('@basekits/kit-object')
const array = require('@basekits/kit-array')
kit.addKit(type)
kit.addKit(object)
kit.addKit(array)

Available Items

The following methods will be available after adding this kit:

.removeDuplicates(arr, deep = false)

Removes duplicate items in the arr array. Performs a strict equality check by default. Set deep to true if you want to perform deep equality check which is useful if arr contains objects or other complex structured types.

const arr1 = ['green', 'black', 'yellow', 'black', 'white']
kit.removeDuplicates(arr1)
// returns ['green', 'black', 'yellow', 'white']

const arr2 = [
  {name: 'a', num: 1},
  {name: 'b', num: 2},
  {name: 'c', num: 3},
  {name: 'a', num: 1}
]
kit.removeDuplicates(arr2, true)
// returns [{name: 'a', num: 1}, {name: 'b', num: 2}, {name: 'c', num: 3}]

.sortItemsBy(arr, paths, order = 'asc')

Sorts array of objects by a specified path.

const arr = [
  {n: 'a', num: 2, props: {num: 3}},
  {n: 'b', num: 3, props: {num: 1}},
  {n: 'c', num: 1, props: {num: 2}},
]

kit.sortItemsBy(arr, 'num', 'asc')
kit.sortItemsBy(arr, ['props', 'num'], 'desc')