Class FastMap<T>

fast map allows for very quick lookups of objects with a unique key

Type parameters

T

Hierarchy

FastMap

Index

Constructors

constructor

Properties

mapObject

Methods

Constructors

constructor

new FastMap<T>(): FastMap<T>

Type parameters
- T
Returns FastMap<T>

Properties

Private mapObject

mapObject: {} = {}

Type declaration

[key: string]: T

Methods

addAllFromOther

addAllFromOther(fastMapArg: FastMap<T>): void

- Defined in lik.fastmap.ts:80
tries to merge another Fastmap Note: uniqueKeyCollisions will cause overwrite

Parameters
- fastMapArg: FastMap<T>
Returns void

addToMap

addToMap(keyArg: string, objectArg: T, optionsArg?: { force: boolean }): boolean

- Defined in lik.fastmap.ts:18
Parameters
- keyArg: string
- objectArg: T
- Optional optionsArg: { force: boolean }
  - force: boolean
Returns boolean

clean

clean(): void

- Defined in lik.fastmap.ts:53
Returns void

concat

concat(fastMapArg: FastMap<T>): FastMap<T>

- Defined in lik.fastmap.ts:60
returns a new Fastmap that includes all values from this and all from the fastmap in the argument

Parameters
- fastMapArg: FastMap<T>
Returns FastMap<T>

find

find(findFunctionArg: (mapItemArg: T) => Promise<boolean>): Promise<T>

- Defined in lik.fastmap.ts:88
Parameters
- findFunctionArg: (mapItemArg: T) => Promise<boolean>
  - - (mapItemArg: T): Promise<boolean>
    - Parameters
      - mapItemArg: T
      Returns Promise<boolean>
Returns Promise<T>

getByKey

getByKey(keyArg: string): T

- Defined in lik.fastmap.ts:33
Parameters
- keyArg: string
Returns T

getKeys

getKeys(): string[]

- Defined in lik.fastmap.ts:43
Returns string[]

isUniqueKey

isUniqueKey(keyArg: string): boolean

- Defined in lik.fastmap.ts:14
Parameters
- keyArg: string
Returns boolean

removeFromMap

removeFromMap(keyArg: string): T

- Defined in lik.fastmap.ts:37
Parameters
- keyArg: string
Returns T

Generated using TypeDoc