Class Group<K, V>

Type Parameters

K = unknown
V = unknown

Hierarchy

Map<K, V>
- Group

Indexable

[x: string]: any

Index

Constructors

constructor

new Group<K, V>(size, it?): Group<K, V>
Type Parameters
- K = unknown
- V = unknown
Parameters
- size: number
- Optional it: Iterable<readonly [K, V]>
Returns Group<K, V>
Overrides Map<K, V>.constructor
- Defined in src/Group/index.ts:4

Properties

`Private` #maxSize

#maxSize: number

`Readonly` [toStringTag]

[toStringTag]: string

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Accessors

maxSize

get maxSize(): number
Returns number
- Defined in src/Group/index.ts:160
set maxSize(value): void
Parameters
- value: number
Returns void
- Defined in src/Group/index.ts:163

Methods

K

K(): K[]
Returns K[]
- Defined in src/Group/index.ts:18

V

V(): V[]
Returns V[]
- Defined in src/Group/index.ts:15

[iterator]

[iterator](): IterableIterator<[K, V]>
Returns an iterable of entries in the map.

Returns IterableIterator<[K, V]>
Inherited from Map.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

add

add(value): Group<K, V>
Parameters
- value: V
Returns Group<K, V>
- Defined in src/Group/index.ts:77

bottom

bottom(amount?): undefined | V | V[]
Parameters
- amount: number = 1
Returns undefined | V | V[]
- Defined in src/Group/index.ts:27

break

break(func): Group<K, V>[]
Parameters
- func: ((val, key, grp) => boolean)
  - - (val, key, grp): boolean
    - Parameters
      val: V
      key: K
      grp: this
      Returns boolean
Returns Group<K, V>[]
- Defined in src/Group/index.ts:151

clear

clear(): void
Returns void
Inherited from Map.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20

clone

clone(): Group<K, V>
Returns Group<K, V>
- Defined in src/Group/index.ts:107

delete

delete(key): boolean
Parameters
- key: K
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from Map.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24

diff

diff(other): Group<K, V>
Parameters
- other: Group<K, V>
Returns Group<K, V>
- Defined in src/Group/index.ts:81

entries

entries(): IterableIterator<[K, V]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[K, V]>
Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

every

every(func): undefined | false
Parameters
- func: ((val, key, grp) => boolean)
  - - (val, key, grp): boolean
    - Parameters
      val: V
      key: K
      grp: this
      Returns boolean
Returns undefined | false
- Defined in src/Group/index.ts:126

filter

filter(func): Group<K, V>
Parameters
- func: ((val, key, grp) => boolean)
  - - (val, key, grp): boolean
    - Parameters
      val: V
      key: K
      grp: this
      Returns boolean
Returns Group<K, V>
- Defined in src/Group/index.ts:8

find

find(func): undefined | V
Parameters
- func: ((val, key, grp) => boolean)
  - - (val, key, grp): boolean
    - Parameters
      val: V
      key: K
      grp: this
      Returns boolean
Returns undefined | V
- Defined in src/Group/index.ts:110

findEntry

findEntry(func): undefined | (K | V)[]
Parameters
- func: ((val, key, grp) => boolean)
  - - (val, key, grp): boolean
    - Parameters
      val: V
      key: K
      grp: this
      Returns boolean
Returns undefined | (K | V)[]
- Defined in src/Group/index.ts:118

findIndex

findIndex(func): undefined | number
Parameters
- func: ((val, key, grp) => boolean)
  - - (val, key, grp): boolean
    - Parameters
      val: V
      key: K
      grp: this
      Returns boolean
Returns undefined | number
- Defined in src/Group/index.ts:136

findKey

findKey(func): undefined | K
Parameters
- func: ((val, key, grp) => boolean)
  - - (val, key, grp): boolean
    - Parameters
      val: V
      key: K
      grp: this
      Returns boolean
Returns undefined | K
- Defined in src/Group/index.ts:114

forEach

forEach(callbackfn, thisArg?): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value, key, map) => void)
  - - (value, key, map): void
    - Parameters
      value: V
      key: K
      map: Map<K, V>
      Returns void
- Optional thisArg: any
Returns void
Inherited from Map.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get(key): undefined | V
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: K
Returns undefined | V
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Inherited from Map.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:33

has

has(key): boolean
Parameters
- key: K
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from Map.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:37

intersect

intersect(other): Group<K, V>
Parameters
- other: Group<K, V>
Returns Group<K, V>
- Defined in src/Group/index.ts:99

keys

keys(): IterableIterator<K>
Returns an iterable of keys in the map

Returns IterableIterator<K>
Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

map

map<T>(func): Group<K, T>
Type Parameters
- T
Parameters
- func: ((val, key, grp) => T)
  - - (val, key, grp): T
    - Parameters
      val: V
      key: K
      grp: this
      Returns T
Returns Group<K, T>
- Defined in src/Group/index.ts:130

pop

pop(): undefined | V
Returns undefined | V
- Defined in src/Group/index.ts:51

popN

popN(amount): undefined | V | V[]
Parameters
- amount: number
Returns undefined | V | V[]
- Defined in src/Group/index.ts:58

reduce

reduce(func, init?): undefined | V
Parameters
- func: ((acc, val, key, grp) => V)
  - - (acc, val, key, grp): V
    - Parameters
      acc: V
      val: V
      key: K
      grp: this
      Returns V
- Optional init: V
Returns undefined | V
- Defined in src/Group/index.ts:143

set

set(key, value): Group<K, V>
Parameters
- key: K
- value: V
Returns Group<K, V>
Overrides Map.set
- Defined in src/Group/index.ts:73

shift

shift(): undefined | V
Returns undefined | V
- Defined in src/Group/index.ts:33

shiftN

shiftN(amount): undefined | V | V[]
Parameters
- amount: number
Returns undefined | V | V[]
- Defined in src/Group/index.ts:40

some

some(func): undefined | true
Parameters
- func: ((val, key, grp) => boolean)
  - - (val, key, grp): boolean
    - Parameters
      val: V
      key: K
      grp: this
      Returns boolean
Returns undefined | true
- Defined in src/Group/index.ts:122

sort

sort(func): Group<K, V>
Parameters
- func: ((a, b) => number)
  - - (a, b): number
    - Parameters
      a: V
      b: V
      Returns number
Returns Group<K, V>
- Defined in src/Group/index.ts:166

sortKeys

sortKeys(func): Group<K, V>
Parameters
- func: ((a, b) => number)
  - - (a, b): number
    - Parameters
      a: K
      b: K
      Returns number
Returns Group<K, V>
- Defined in src/Group/index.ts:175

toJSON

toJSON(): Record<string, V>
Returns Record<string, V>
- Defined in src/Group/index.ts:180

top

top(amount?): undefined | V | V[]
Parameters
- amount: number = 1
Returns undefined | V | V[]
- Defined in src/Group/index.ts:21

union

union(other): Group<K, V>
Parameters
- other: Group<K, V>
Returns Group<K, V>
- Defined in src/Group/index.ts:88

values

values(): IterableIterator<V>
Returns an iterable of values in the map

Returns IterableIterator<V>
Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

weakSort

weakSort(): Group<K, V>
Returns Group<K, V>
- Defined in src/Group/index.ts:171

`Static` groupBy

groupBy<K, T>(items, keySelector): Map<K, T[]>
Groups members of an iterable according to the return value of the passed callback.
Type Parameters
- K
- T
Parameters
- items: Iterable<T>
  An iterable.
- keySelector: ((item, index) => K)
  A callback which will be invoked for each item in items.
  - - (item, index): K
    - Parameters
      item: T
      index: number
      Returns K
Returns Map<K, T[]>
Inherited from Map.groupBy
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:25

Class Group<K, V>

Type Parameters

Hierarchy

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Group<K, V>

Properties

Private #maxSize

Readonly [toStringTag]

Readonly size

Returns

Static Readonly [species]

Accessors

maxSize

Returns number

Parameters

Returns void

Methods

K

Returns K[]

V

Returns V[]

[iterator]

Returns IterableIterator<[K, V]>

add

Parameters

Returns Group<K, V>

bottom

Parameters

Returns undefined | V | V[]

break

Parameters

Parameters

Returns boolean

Returns Group<K, V>[]

clear

Returns void

clone

Returns Group<K, V>

delete

Parameters

Returns boolean

diff

Parameters

Returns Group<K, V>

entries

Returns IterableIterator<[K, V]>

every

Parameters

Parameters

Returns boolean

Returns undefined | false

filter

Parameters

Parameters

Returns boolean

Returns Group<K, V>

find

Parameters

Parameters

Returns boolean

Returns undefined | V

findEntry

Parameters

Parameters

Returns boolean

Returns undefined | (K | V)[]

findIndex

Parameters

Parameters

Returns boolean

Returns undefined | number

`Private` #maxSize

`Readonly` [toStringTag]

`Readonly` size

`Static` `Readonly` [species]