Array Collection

How to Install

1. install NPM

$ npm install --save array-collection

2. import file in Project

import Collection from 'array-collection'

Table of Contents

SQL Query

|Functions|Parameters|Types |---|---|---| |delete|primaryKey|any| |insert|newData|object| |merge|array|array| |orderBy|field , sort|asc desc| |select|field|string| |update|updateData|object| |where|field , condition , key|string , condition , string number| |whereIn|field , keyArray|[string number]|

Return Data

|Functions|Parameters|Types|Return| |---|---|---|---| |avg |field|string number|number| |count | ||number| |first | ||{}| |firstOrFail| ||{}| |get |field|string number|[]| |max |field|string number|number| |min |field|string number|number| |toArray | ||[]|

Data Example

const fruits = [
  {
    id: 1,
    name: 'Mango',
    price: 20,
  },
  {
    id: 2,
    name: 'Banana',
    price: 100,
  },
  {
    id: 3,
    name: 'Apple',
    price: 50,
  },
  {
    id: 4,
    name: 'Orange',
    price: 40,
  },
]

// Create Array Collection
const Data = new Collection(fruits, 'id')

avg

Data.avg('price') // result = 52.5

count

Data.count() // result = 4

delete

Data.delete(2)

/*
fruits = [
  {
    id: 1,
    name: 'Mango',
    price: 20,
  },
  {
    id: 3,
    name: 'Apple',
    price: 50,
  },
  {
    id: 4,
    name: 'Orange',
    price: 40,
  }
]
*/

find

Data.find(2)

/*
fruits = [
  {
    id: 2,
    name: 'Banana',
    price: 100,
  }
]
*/

Example

const Data = new Collection([1,2,3,4], 'primaryKey')

// Select Data => Collection
Data.select(['id','name'])
Data.where('id', '=', 1).get() => [1]
Data.whereIn('id', [1,2]).get() => [1,2]
Data.whereNotIn('id', [1,2]).get() => [3,4]
Data.orderBy('name','asc').get() => [1,2,3,4] && [A - Z]
Data.orderBy('name','desc').get() => [4,3,2,1] && [Z - A]

// Insert Data => []
Data.insert({
  id: 1
  name: 'Update String'
})

// Update Data => []
Data.where('id', '=', 1).update({
  name: 'Update String'
})

// Delete Data => []
Data.delete(1)

// Compact Data
Data.get() => []
Data.firstOrFail() => {} || Array[0]
Data.count() => number