Class Collection<T>

Type parameters

T: IModel

Hierarchy

Event
- Collection

Implements

IEvent
ICollection<T>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Collection(array?: any[] | T[]): Collection

- Defined in classes/Collection.ts:11
Parameters
- Default value array: any[] | T[] = []
Returns Collection

Properties

Private Type

Type: object

Type declaration

Protected _events

_events: object

Type declaration

[event: string]: IHandler[]

Private _models

_models: object

Type declaration

[key: string]: T | IModel

Methods

Private _clearCollection

_clearCollection(): void

- Defined in classes/Collection.ts:34
Returns void

Private _destroyCollection

_destroyCollection(): void

- Defined in classes/Collection.ts:262
Returns void

Private _init

_init(array: T[] | any[]): void

- Defined in classes/Collection.ts:18
Parameters
- array: T[] | any[]
Returns void

Protected _offAllListener

_offAllListener(): void

Inherited from Event._offAllListener
- Defined in classes/Event.ts:57
Returns void

add

add(model: T | IModel): boolean

Implementation of ICollection.add
- Defined in classes/Collection.ts:45
Add Model to Collection

Parameters
- model: T | IModel
Returns boolean

chunk

chunk(size?: number): T[][]

Implementation of ICollection.chunk
- Defined in classes/Collection.ts:231
Chunk Array on size

Parameters
- Default value size: number = 1
Returns T[][]

clear

clear(): void

Implementation of ICollection.clear
- Defined in classes/Collection.ts:84
Clear Collection, events will be saving

Returns void

countBy

countBy(predicate: IPredicate): object

Implementation of ICollection.countBy
- Defined in classes/Collection.ts:240
Count element by predicate

Parameters
- predicate: IPredicate
Returns object
- [key: string]: number

destroy

destroy(): void

Implementation of ICollection.destroy
- Defined in classes/Collection.ts:256
Destroy Collection

Returns void

each

each(predicate: IPredicate): T[]

Implementation of ICollection.each
- Defined in classes/Collection.ts:152
Iterate collection by predicate

Parameters
- predicate: IPredicate
Returns T[]

filter

filter(predicate: IPredicate): T[]

Implementation of ICollection.filter
- Defined in classes/Collection.ts:94
Filtering collection by predicate

Parameters
- predicate: IPredicate
Returns T[]

find

find(predicate: IPredicate, startIndex?: number): T | undefined

Implementation of ICollection.find
- Defined in classes/Collection.ts:125
Find by predicate in Collection

Parameters
- predicate: IPredicate
- Default value startIndex: number = 0
Returns T | undefined

getAll

getAll(): T[]

Implementation of ICollection.getAll
- Defined in classes/Collection.ts:143
Get Array from Collection

Returns T[]

getById

getById(id: string): T | IModel

Implementation of ICollection.getById
- Defined in classes/Collection.ts:112
Get Model by Id

Parameters
- id: string
Returns T | IModel

getLength

getLength(): number

Implementation of ICollection.getLength
- Defined in classes/Collection.ts:196
Get Collection length

Returns number

groupBy

groupBy(predicate: IPredicate): object

Implementation of ICollection.groupBy
- Defined in classes/Collection.ts:249
Group Collection ny predicate

Parameters
- predicate: IPredicate
Returns object

|undefined|null)[]>}
- [key: string]: T[]

has

has(model: T | IModel): boolean

Implementation of ICollection.has
- Defined in classes/Collection.ts:77
Check existing Model in Collection

Parameters
- model: T | IModel
Returns boolean

map

map(predicate: IPredicate): any[]

Implementation of ICollection.map
- Defined in classes/Collection.ts:103
Create new Array from Collection

Parameters
- predicate: IPredicate
Returns any[]

merge

merge(collection: T[] | ICollection<T> | any[]): any[] | T[]

Implementation of ICollection.merge
- Defined in classes/Collection.ts:161
Merge collection with array or another collection

Parameters
- collection: T[] | ICollection<T> | any[]
Returns any[] | T[]

off

off(eventName: string, handler?: IHandler): void

Inherited from Event.off
- Defined in classes/Event.ts:34
Remove handler from Event

Parameters
- eventName: string
- Optional handler: IHandler
Returns void

on

on(eventsName: string | string[], handler: IHandler): void

Implementation of IEvent.on

Inherited from Event.on
- Defined in classes/Event.ts:12
Add handler on Event

Parameters
- eventsName: string | string[]
- handler: IHandler
Returns void

reduce

reduce(predicate: IPredicate, accum?: any): any

Implementation of ICollection.reduce
- Defined in classes/Collection.ts:135
Reduce new Collection

Parameters
- predicate: IPredicate
- Default value accum: any = 0
Returns any

|undefined|null}

remove

remove(model: T | IModel): boolean

Implementation of ICollection.remove
- Defined in classes/Collection.ts:61
Remove Model from Collection

Parameters
- model: T | IModel
Returns boolean

reset

reset(array?: any[] | T[]): void

Implementation of ICollection.reset
- Defined in classes/Collection.ts:186
Reset Collection with new Array of Model or JSON

Parameters
- Default value array: any[] | T[] = []
Returns void

sortBy

sortBy(predicate: IPredicate): void

Implementation of ICollection.sortBy
- Defined in classes/Collection.ts:214
Sort element with predicate

Parameters
- predicate: IPredicate
Returns void

toArray

toArray(): T[]

Implementation of ICollection.toArray
- Defined in classes/Collection.ts:222
Get Array from Collection

Returns T[]

toJSON

toJSON(): any

Implementation of ICollection.toJSON
- Defined in classes/Collection.ts:204
Return JSOn from Collection

Returns any

trigger

trigger(eventName: string, eventParams?: __type | undefined | null): void

Implementation of IEvent.trigger

Inherited from Event.trigger
- Defined in classes/Event.ts:49
Trigger Event with Param

Parameters
- eventName: string
- Default value eventParams: __type | undefined | null = {}
Returns void

Static Protected _isUndefined

_isUndefined(obj: any): boolean

Inherited from Event._isUndefined
- Defined in classes/Event.ts:61
Parameters
- obj: any
Returns boolean

Generated using TypeDoc