--- layout: posts title: Api - Collector Class ---

Collects items that share a common key.

Type parameters

K
T

Hierarchy

Collector

Index

Constructors

constructor

Properties

collections

Methods

Constructors

constructor

new Collector(comparer?: ICollectionKeyComparer<K>): Collector

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:22
Parameters
- Optional comparer: ICollectionKeyComparer<K>
Returns Collector

Properties

collections

collections: ICollection<K, T>[]

Methods

addItemToCollection

addItemToCollection(key: K, item: T): void

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:27
Parameters
- key: K
- item: T
Returns void

findCollection

findCollection(key: K, action?: function): T[]

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:37
Parameters
- key: K
- Optional action: function
  - - (index: number): void
    - Parameters
      - index: number
      Returns void
Returns T[]

getCollectionsOfMultiple

getCollectionsOfMultiple(cb: function): void

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:76
Parameters
- cb: function
  - - (key: K, items: T[]): void
    - Parameters
      - key: K
      - items: T[]
      Returns void
Returns void

removeCollection

removeCollection(key: K): boolean

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:52
Parameters
- key: K
Returns boolean

removeItemFromCollection

removeItemFromCollection(key: K, item: T): boolean

- Defined in src/maker.js/packages/maker.js/src/core/collect.ts:61
Parameters
- key: K
- item: T
Returns boolean

Generated using TypeDoc