Class Chain

Hierarchy

Chain

Index

Constructors

constructor

Properties

data

Methods

Constructors

constructor

new Chain(data: ICollectionItem[]): Chain

- Defined in src/core/Chain.ts:8
Parameters
- data: ICollectionItem[]
Returns Chain

Properties

Protected data

data: ICollectionItem[]

Methods

filter

filter(condition: (item: ICollectionItem) => boolean | IConditionObject | [string, any]): Chain

- Defined in src/core/Chain.ts:18
Find all collection items where condition is truth

Parameters
- condition: (item: ICollectionItem) => boolean | IConditionObject | [string, any]
  - - (item: ICollectionItem): boolean | IConditionObject | [string, any]
    - Parameters
      - item: ICollectionItem
      Returns boolean | IConditionObject | [string, any]
Returns Chain

findById

findById(id: string): ICollectionItem

- Defined in src/core/Chain.ts:40
Get single collection item by id

Parameters
- id: string
Returns ICollectionItem

findOne

findOne(condition: (item: ICollectionItem) => boolean | IConditionObject | [string, any]): ICollectionItem

- Defined in src/core/Chain.ts:47
Find first where condition is truth

Parameters
- condition: (item: ICollectionItem) => boolean | IConditionObject | [string, any]
  - - (item: ICollectionItem): boolean | IConditionObject | [string, any]
    - Parameters
      - item: ICollectionItem
      Returns boolean | IConditionObject | [string, any]
Returns ICollectionItem

group

group(key: string): IChainGroup

- Defined in src/core/Chain.ts:32
Returns grouped items by required key.

Parameters
- key: string
Returns IChainGroup

paginate

paginate(itemsPerPage: number): Paginator

- Defined in src/core/Chain.ts:54
Paginate your collection by required number of items for each page;

Parameters
- itemsPerPage: number
Returns Paginator

sort

sort(key: string[] | string, dir: Sorting[] | Sorting): Chain

- Defined in src/core/Chain.ts:25
Sort collection by key.

Parameters
- key: string[] | string
- dir: Sorting[] | Sorting
Returns Chain