Class BasePool<K, V>

Type parameters

K
V

Hierarchy

Map<K, V>
- BasePool

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BasePool<K, V>(client: Client, name: string, type: unknown): BasePool<K, V>

Overrides Map<K, V>.constructor
- Defined in src/lib/structures/Pools/Base/BasePool.ts:15
Type parameters
- K
- V
Parameters
- client: Client
- name: string
- type: unknown
Returns BasePool<K, V>

Properties

Readonly [toStringTag]

[toStringTag]: string

Readonly client

client: Client

Readonly name

name: string

The name of the pool

Readonly size

size: number

Readonly type

type: unknown

The class type the pool holds

Static Readonly [species]

[species]: MapConstructor

Methods

[iterator]

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

Inherited from Map.__@iterator@81
- Defined in ../../../../../opt/hostedtoolcache/node/12.22.5/x64/lib/node_modules/typescript/lib/lib.es2015.iterable.d.ts:121
Returns an iterable of entries in the map.

Returns IterableIterator<[K, V]>

Private _walk

_walk(): Promise<Item[]>

- Defined in src/lib/structures/Pools/Base/BasePool.ts:105
Returns an array of all the core and user files

Returns Promise<Item[]>

clear

clear(): void

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

delete

delete(key: K): boolean

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

entries

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

Inherited from Map.entries
- Defined in ../../../../../opt/hostedtoolcache/node/12.22.5/x64/lib/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]>

forEach

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

Inherited from Map.forEach
- Defined in ../../../../../opt/hostedtoolcache/node/12.22.5/x64/lib/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 ../../../../../opt/hostedtoolcache/node/12.22.5/x64/lib/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 ../../../../../opt/hostedtoolcache/node/12.22.5/x64/lib/node_modules/typescript/lib/lib.es2015.collection.d.ts:26
Parameters
- key: K
Returns boolean

init

init(): Promise<boolean>

- Defined in src/lib/structures/Pools/Base/BasePool.ts:24
Initialize the pool

Returns Promise<boolean>

keys

keys(): IterableIterator<K>

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

Returns IterableIterator<K>

load

load(filePath: string): Promise<boolean>

- Defined in src/lib/structures/Pools/Base/BasePool.ts:55
Loads a class into the pool

Parameters
- filePath: string
  
  The path to the file
Returns Promise<boolean>

set

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

Inherited from Map.set
- Defined in ../../../../../opt/hostedtoolcache/node/12.22.5/x64/lib/node_modules/typescript/lib/lib.es2015.collection.d.ts:27
Parameters
- key: K
- value: V
Returns BasePool<K, V>

values

values(): IterableIterator<V>

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

Returns IterableIterator<V>

Generated using TypeDoc