Class Collection<T>`Abstract`

Abstract Collection type

Type Parameters

T

Hierarchy (View Summary)

Collection
- StoreCollection

Index

Constructors

Methods

delete entries filter find forEach get has keys map size toList values

Constructors

constructor

new Collection<T>(): Collection<T>
Type Parameters
- T
Returns Collection<T>

Methods

`Abstract`delete

delete(id: string): void
Delete an object
Parameters
- id: string
  Id
Returns void
- Defined in src/collections/Collection.ts:31

`Abstract`entries

entries(): IterableIterator<[string, T]>
Iterable of key, value pairs in the map

Returns IterableIterator<[string, T]>
Iterable
- Defined in src/collections/Collection.ts:55

filter

filter(predicate: (value: T, key: string) => boolean): T[]
Filter the collection by a given predicate
Parameters
- predicate: (value: T, key: string) => boolean
  Predicate to satisfy
Returns T[]
- Defined in src/collections/Collection.ts:77

find

find(predicate: (value: T, key: string) => boolean): undefined | T
Find some value based on a predicate
Parameters
- predicate: (value: T, key: string) => boolean
  Predicate to satisfy
Returns undefined | T
- Defined in src/collections/Collection.ts:105

`Abstract`forEach

forEach(cb: (value: T, key: string, map: Map<string, T>) => void): void
Execute a provided function over each key, value pair in the map
Parameters
- cb: (value: T, key: string, map: Map<string, T>) => void
  Callback for each pair
Returns void
- Defined in src/collections/Collection.ts:61

`Abstract`get

get(id: string): undefined | T
Get an existing object
Parameters
- id: string
  Id
Returns undefined | T
Object
- Defined in src/collections/Collection.ts:18

`Abstract`has

has(id: string): boolean
Check whether an id exists in the Collection
Parameters
- id: string
  Id
Returns boolean
Whether it exists
- Defined in src/collections/Collection.ts:25

`Abstract`keys

keys(): IterableIterator<string>
Iterable of keys in the map

Returns IterableIterator<string>
Iterable
- Defined in src/collections/Collection.ts:43

map

map<O>(cb: (value: T, key: string) => O): O[]
Map the collection using a given callback
Type Parameters
- O
Parameters
- cb: (value: T, key: string) => O
  Callback
Returns O[]
- Defined in src/collections/Collection.ts:92

`Abstract`size

size(): number
Number of stored objects

Returns number
Size
- Defined in src/collections/Collection.ts:37

toList

toList(): T[]
List of values in the map

Returns T[]
List
- Defined in src/collections/Collection.ts:69

`Abstract`values

values(): IterableIterator<T>
Iterable of values in the map

Returns IterableIterator<T>
Iterable
- Defined in src/collections/Collection.ts:49