Class VectorMap<U, V>

Type parameters

U
V

Hierarchy

VectorMap

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new VectorMap<U, V>(arr?: [U, V][]): VectorMap<U, V>

- Defined in map.ts:29
Create a new VectorMap.

Type parameters
- U
- V
Parameters
- Optional arr: [U, V][]
  
  Initial data which has pairs of key and value.
Returns VectorMap<U, V>

Properties

pointer

pointer: Map<U, number>

Pointer map.

It contains an index of the source array to access the target directly.

source

source: MapSource<U, V>[]

Data source array.

Accessors

head

get head(): undefined | MapSource<U, V>

- Defined in map.ts:87
Get head of map.

Returns undefined | MapSource<U, V>

size

get size(): number

- Defined in map.ts:315
Size of map.

Returns number

tail

get tail(): undefined | MapSource<U, V>

- Defined in map.ts:97
Get tail of map.

Returns undefined | MapSource<U, V>

Methods

[iterator]

[iterator](): Generator<MapSource<U, V>, void, unknown>

- Defined in map.ts:115
Returns Generator<MapSource<U, V>, void, unknown>

clear

clear(): void

- Defined in map.ts:151
Clear map.

Returns void

delete

delete(key: U, callback?: (swapped: MapSource<U, V>, deleted: MapSource<U, V>) => any): boolean

- Defined in map.ts:128
Swap item with tail and remove it from map.

Parameters
- key: U
  
  key.
- Optional callback: (swapped: MapSource<U, V>, deleted: MapSource<U, V>) => any
  
  Calls callback when item swapped with tail. Arguments are reference of each item, and 'key' is the key of map that indicates array index(pointer), therefore should be careful to not modify 'key' or it could make mangling pointer.
  - - (swapped: MapSource<U, V>, deleted: MapSource<U, V>): any
    - Parameters
      - swapped: MapSource<U, V>
      - deleted: MapSource<U, V>
      Returns any
Returns boolean

forEach

forEach(callback: (data: MapSource<U, V>, index: number, arr: MapSource<U, V>[]) => any): void

- Defined in map.ts:62
Iterate items. Same to Array.forEach in source array.

Parameters
- callback: (data: MapSource<U, V>, index: number, arr: MapSource<U, V>[]) => any
  
  callback function to execute every iteration.
  - - (data: MapSource<U, V>, index: number, arr: MapSource<U, V>[]): any
    - Parameters
      - data: MapSource<U, V>
      - index: number
      - arr: MapSource<U, V>[]
      Returns any
Returns void

get

get(key: U): undefined | V

- Defined in map.ts:239
Get item from map.

Parameters
- key: U
  
  key.
Returns undefined | V

getIndex

getIndex(key: U): undefined | number

- Defined in map.ts:255
Get index(pointer) of item.

Parameters
- key: U
  
  key.
Returns undefined | number

has

has(key: U): boolean

- Defined in map.ts:231
Check if item exists.

Parameters
- key: U
  
  key.
Returns boolean

map

map<T>(mapFunc: (data: MapSource<U, V>, index: number, arr: MapSource<U, V>[]) => T): T[]

- Defined in map.ts:71
Generate a new array. Same to Array.map in source array.

Type parameters
- T
Parameters
- mapFunc: (data: MapSource<U, V>, index: number, arr: MapSource<U, V>[]) => T
  
  map function to execute every iteration.
  - - (data: MapSource<U, V>, index: number, arr: MapSource<U, V>[]): T
    - Parameters
      - data: MapSource<U, V>
      - index: number
      - arr: MapSource<U, V>[]
      Returns T
Returns T[]
Array.

pop

pop(): undefined | MapSource<U, V>

- Defined in map.ts:282
Pop out last item like array.

Returns undefined | MapSource<U, V>

reduce

reduce<T>(reducer: (acc: T, data: MapSource<U, V>, index: number, arr: MapSource<U, V>[]) => T, accumulator: T): T

- Defined in map.ts:110
Reduce map. Same to Array.reduce in source array.

Type parameters
- T
Parameters
- reducer: (acc: T, data: MapSource<U, V>, index: number, arr: MapSource<U, V>[]) => T
  
  reducer function to execute every iteration.
  - - (acc: T, data: MapSource<U, V>, index: number, arr: MapSource<U, V>[]): T
    - Parameters
      - acc: T
      - data: MapSource<U, V>
      - index: number
      - arr: MapSource<U, V>[]
      Returns T
- accumulator: T
  
  default value of accumulator.
Returns T
T

reverse

reverse(): void

- Defined in map.ts:294
Reverse order of source array.

Returns void

set

set(key: U, value: V): number

- Defined in map.ts:264
Add item in map and return its index.

Parameters
- key: U
  
  key.
- value: V
  
  value.
Returns number

shallowClone

shallowClone(): VectorMap<U, V>

- Defined in map.ts:305
shallow clone itself. Useful when use with immutable state management (ex. React state).

Returns VectorMap<U, V>

some

some(someFunc: (data: MapSource<U, V>, index: number, arr: MapSource<U, V>[]) => boolean): boolean

- Defined in map.ts:80
Equivalent to Array.some.

Parameters
- someFunc: (data: MapSource<U, V>, index: number, arr: MapSource<U, V>[]) => boolean
  
  function to execute every iteration. Must return boolean type.
  - - (data: MapSource<U, V>, index: number, arr: MapSource<U, V>[]): boolean
    - Parameters
      - data: MapSource<U, V>
      - index: number
      - arr: MapSource<U, V>[]
      Returns boolean
Returns boolean
boolean.

swap

swap(key1: U, key2: U): void

- Defined in map.ts:162
Swap item without preserve its order. Equivalent to swapPointer + swapOrder, but more simple & efficient.

Parameters
- key1: U
  
  key 1.
- key2: U
  
  key 2.
Returns void

swapIndex

swapIndex(key1: U, key2?: U): void

- Defined in map.ts:205
Swap source order.

Parameters
- key1: U
  
  key 1.
- Optional key2: U
  
  key 2.
Returns void

swapPointer

swapPointer(key1: U, key2: U): void

- Defined in map.ts:184
Swap item with preserve its order.

Parameters
- key1: U
  
  key 1.
- key2: U
  
  key 2.
Returns void

Generated using TypeDoc