Dict | @devnote-dev/pterojs

Dict (or Dictionary) is an extended Map with additional helper methods used for manager caches in the PteroJS library.

Type Parameters

Hierarchy

Map<K, V>
- Dict

Index

Constructors

constructor

Properties

Accessors

limit

Methods

Constructors

constructor

new Dict<K, V>(entries?: null | readonly (readonly [K, V])[]): Dict<K, V>
new Dict<K, V>(iterable?: null | Iterable<readonly [K, V]>): Dict<K, V>

Inherited from Map<K, V>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:33
Type Parameters
- K
- V
Parameters
- Optional entries: null | readonly (readonly [K, V])[]
Returns Dict<K, V>
Inherited from Map<K, V>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:161
Type Parameters
- K
- V
Parameters
- Optional iterable: null | Iterable<readonly [K, V]>
Returns Dict<K, V>

Properties

Readonly [toStringTag]

[toStringTag]: string

constructor

constructor: DictConstructor

Readonly size

size: number

Static Readonly [species]

[species]: MapConstructor

Accessors

limit

get limit(): number

- Defined in src/structures/Dict.ts:18
Returns number

Methods

[iterator]

[iterator](): IterableIterator<[K, V]>

Inherited from Map.__@iterator@85
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:121
Returns an iterable of entries in the map.

Returns IterableIterator<[K, V]>

clear

clear(): void

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

clone

clone(): Dict<K, V>

- Defined in src/structures/Dict.ts:272
Returns Dict<K, V>
A clone of the dict.

delete

delete(key: K): boolean

Inherited from Map.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:23
Parameters
- key: K
Returns boolean

difference

difference(dict: Dict<K, V>): Dict<K, V>

- Defined in src/structures/Dict.ts:255
Parameters
- dict: Dict<K, V>
  
  The dict to compare differences to.
Returns Dict<K, V>
A dict containing the different entries between both dicts.

entries

entries(): IterableIterator<[K, V]>

Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:126
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[K, V]>

every

every(fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)): boolean

- Defined in src/structures/Dict.ts:56
Checks if all the entries in the dict pass the function.

Parameters
- fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)
  
  The function to apply to the dict.
  - - (value: V, key: K, dict: Dict<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - dict: Dict<K, V>
      Returns boolean
Returns boolean

filter

filter(fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)): Dict<K, V>

- Defined in src/structures/Dict.ts:179
Applies the function to each entry in the dict and returns a dict of the results that passed.

Parameters
- fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)
  
  The function to apply to the dict.
  - - (value: V, key: K, dict: Dict<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - dict: Dict<K, V>
      Returns boolean
Returns Dict<K, V>
The filtered dict.

find

find(fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)): undefined | V

- Defined in src/structures/Dict.ts:193
Applies a function to each entry in the dict and returns the first one that passes.

Parameters
- fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)
  
  The function to apply to the dict.
  - - (value: V, key: K, dict: Dict<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - dict: Dict<K, V>
      Returns boolean
Returns undefined | V

first

first<T>(amount?: T): T extends undefined ? V : V[]

- Defined in src/structures/Dict.ts:81
Returns the first entry (or entries if otherwise specified) in the dict.

Type Parameters
- T extends undefined | number
Parameters
- Optional amount: T
Returns T extends undefined ? V : V[]

firstKey

firstKey<T>(amount?: T): T extends undefined ? K : K[]

- Defined in src/structures/Dict.ts:94
Returns the first key (or keys if otherwise specified) in the dict.

Type Parameters
- T extends undefined | number
Parameters
- Optional amount: T
Returns T extends undefined ? K : K[]

forEach

forEach(callbackfn: ((value: V, key: K, map: Map<K, V>) => void), thisArg?: any): void

Inherited from Map.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24
Parameters
- callbackfn: ((value: V, key: K, map: Map<K, V>) => void)
  - - (value: V, key: K, map: Map<K, V>): void
    - Parameters
      - value: V
      - key: K
      - map: Map<K, V>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: K): undefined | V

Inherited from Map.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:25
Parameters
- key: K
Returns undefined | V

has

has(key: K): boolean

Inherited from Map.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:26
Parameters
- key: K
Returns boolean

hasAll

hasAll(...keys: K[]): boolean

- Defined in src/structures/Dict.ts:73
Checks that all of the specified keys exist in the dict.

Parameters
- Rest ...keys: K[]
  
  The keys to check for.
Returns boolean

hasAny

hasAny(...keys: K[]): boolean

- Defined in src/structures/Dict.ts:65
Checks that any of the specified keys exist in the dict.

Parameters
- Rest ...keys: K[]
  
  The keys to check for.
Returns boolean

isLimited

isLimited(): boolean

- Defined in src/structures/Dict.ts:33
Returns boolean
Whether the dict has a set limit.

join

join(...dict: Dict<K, V>[]): Dict<K, V>

- Defined in src/structures/Dict.ts:244
Joins one or more dicts with the current one and returns the value.

Parameters
- Rest ...dict: Dict<K, V>[]
  
  The dicts to join.
Returns Dict<K, V>
The joined dicts.

keys

keys(): IterableIterator<K>

Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:131
Returns an iterable of keys in the map

Returns IterableIterator<K>

last

last<T>(amount?: T): T extends undefined ? V : V[]

- Defined in src/structures/Dict.ts:107
Returns the last entry (or entries if otherwise specified) in the dict.

Type Parameters
- T extends undefined | number
Parameters
- Optional amount: T
Returns T extends undefined ? V : V[]

lastKey

lastKey<T>(amount?: T): T extends undefined ? K : K[]

- Defined in src/structures/Dict.ts:120
Returns the last key (or keys if otherwise specified) in the dict.

Type Parameters
- T extends undefined | number
Parameters
- Optional amount: T
Returns T extends undefined ? K : K[]

map

map<T>(fn: ((value: V, key: K, dict: Dict<K, V>) => T)): T[]

- Defined in src/structures/Dict.ts:167
Applies the function to each entry in the dict and returns an array of the results.

Type Parameters
- T
Parameters
- fn: ((value: V, key: K, dict: Dict<K, V>) => T)
  
  The function to apply to the dict.
  - - (value: V, key: K, dict: Dict<K, V>): T
    - Parameters
      - value: V
      - key: K
      - dict: Dict<K, V>
      Returns T
Returns T[]
The mapped results.

part

part(fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)): Dict<K, V>[]

- Defined in src/structures/Dict.ts:220
Applies a function to each entry in the dict and returns 2 dicts, the first containing entries that passed the function and the second containing the failed entries.

Parameters
- fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)
  
  The function to apply to the dict.
  - - (value: V, key: K, dict: Dict<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - dict: Dict<K, V>
      Returns boolean
Returns Dict<K, V>[]
The passed and failed dicts.

random

random<T>(amount?: T): T extends undefined ? V : V[]

- Defined in src/structures/Dict.ts:133
Returns a random entry (or entries if otherwise specified) in the dict.

Type Parameters
- T extends undefined | number
Parameters
- Optional amount: T
Returns T extends undefined ? V : V[]

randomKey

randomKey<T>(amount?: T): T extends undefined ? K : K[]

- Defined in src/structures/Dict.ts:149
Returns a random key (or keys if otherwise specified) in the dict.

Type Parameters
- T extends undefined | number
Parameters
- Optional amount: T
Returns T extends undefined ? K : K[]

reduce

reduce<T>(fn: ((value: V, key: K, dict: Dict<K, V>) => T), acc: T): T

- Defined in src/structures/Dict.ts:234
Reduces each entry in the dict to a single value.

Type Parameters
- T
Parameters
- fn: ((value: V, key: K, dict: Dict<K, V>) => T)
  
  The function to apply to the dict.
  - - (value: V, key: K, dict: Dict<K, V>): T
    - Parameters
      - value: V
      - key: K
      - dict: Dict<K, V>
      Returns T
- acc: T
Returns T
The reduced value.

set

set(key: K, value: V): Dict<K, V>

Overrides Map.set
- Defined in src/structures/Dict.ts:37
Parameters
- key: K
- value: V
Returns Dict<K, V>

setLimit

setLimit(amount: number): void

- Defined in src/structures/Dict.ts:27
Sets a limit for the number of entries the dict can have. Note: this cannot be changed once set. Attempting to will throw an error.

Parameters
- amount: number
  
  The number of entries allowed for the dict.
Returns void

some

some(fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)): boolean

- Defined in src/structures/Dict.ts:47
Checks if at least one of the entries in the dict pass the function.

Parameters
- fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)
  
  The function to apply to the dict.
  - - (value: V, key: K, dict: Dict<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - dict: Dict<K, V>
      Returns boolean
Returns boolean

sweep

sweep(fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)): number

- Defined in src/structures/Dict.ts:207
Applies a function to each entry in the dict and returns the number of items removed.

Parameters
- fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)
  
  The function to apply to the dict.
  - - (value: V, key: K, dict: Dict<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - dict: Dict<K, V>
      Returns boolean
Returns number
The number of sweeped entries.

update

update(dict: Dict<K, V>): void

- Defined in src/structures/Dict.ts:267
Updates the values of the current dict with the specified dict, settings the values in place.

Parameters
- dict: Dict<K, V>
  
  The dict to update with.
Returns void

values

values(): IterableIterator<V>

Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:136
Returns an iterable of values in the map

Returns IterableIterator<V>

Type Parameters

K

V

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

K

V

Parameters

Optional entries: null | readonly (readonly [K, V])[]

Returns Dict<K, V>

Type Parameters

K

V

Parameters

Optional iterable: null | Iterable<readonly [K, V]>

Returns Dict<K, V>

Properties

Readonly [toStringTag]

constructor

Readonly size

Static Readonly [species]

Accessors

limit

Returns number

Methods

[iterator]

Returns IterableIterator<[K, V]>

clear

Returns void

clone

Returns Dict<K, V>

delete

Parameters

key: K

Returns boolean

difference

Parameters

dict: Dict<K, V>

Returns Dict<K, V>

entries

Returns IterableIterator<[K, V]>

every

Parameters

fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)

Parameters

value: V

key: K

dict: Dict<K, V>

Returns boolean

Returns boolean

filter

Parameters

fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)

Parameters

value: V

key: K

dict: Dict<K, V>

Returns boolean

Returns Dict<K, V>

find

Parameters

fn: ((value: V, key: K, dict: Dict<K, V>) => boolean)

Parameters

value: V

key: K

dict: Dict<K, V>

Returns boolean

Returns undefined | V

first

Type Parameters

T extends undefined | number

Parameters

Optional amount: T