BaseClientCollection | Detritus Client

Basic Client Collection, the ShardClient instance is attached to this

Type parameters

Hierarchy

BaseCollection<K, V>
- BaseClientCollection
  - Applications
  - Channels
  - ConnectedAccounts
  - Guilds
  - Messages
  - Notes
  - Presences
  - Relationships
  - Sessions
  - Users
  - VoiceCalls
  - VoiceConnections

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseClientCollection(client: ShardClient, options?: BaseClientCollectionOptions | boolean): BaseClientCollection

Overrides BaseCollection.__constructor
- Defined in src/collections/basecollection.ts:175
Parameters
- client: ShardClient
- Default value options: BaseClientCollectionOptions | boolean = {}
Returns BaseClientCollection

Properties

[Symbol.toStringTag]

[Symbol.toStringTag]: string

Optional _lastUsed

_lastUsed: Map<K, number>

cache

cache: Map<K, V>

client

client: ShardClient

enabled

enabled: boolean

Optional expire

expire: undefined | number

Optional interval

interval: Timers.Interval

intervalTime

intervalTime: number

lastUsed

lastUsed: Map<K, number>

length

length: number

limit

limit: number

shouldStartInterval

shouldStartInterval: boolean

size

size: number

Methods

[Symbol.iterator]

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

Inherited from BaseCollection.[Symbol.iterator]

Overrides BaseCollectionMixin.[Symbol.iterator]
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:54
Returns IterableIterator<[K, V]>

clear

clear(): void

Inherited from BaseCollection.clear

Overrides BaseCollectionMixin.clear
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:45
Returns void

clone

clone(): BaseCollection<K, V>

Inherited from BaseCollection.clone
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:46
Returns BaseCollection<K, V>

delete

delete(key: K): boolean

Inherited from BaseCollection.delete
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:47
Parameters
- key: K
Returns boolean

entries

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

Inherited from BaseCollectionMixin.entries
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:6
Returns IterableIterator<[K, V]>

every

every(func: function): boolean

Inherited from BaseCollectionMixin.every
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:7
Parameters
- func: function
  - - (v: V, k: K): boolean
    - Parameters
      - v: V
      - k: K
      Returns boolean
Returns boolean

filter

filter(func: function): Array<V>

Inherited from BaseCollectionMixin.filter
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:8
Parameters
- func: function
  - - (v: V, k: K): boolean
    - Parameters
      - v: V
      - k: K
      Returns boolean
Returns Array<V>

find

find(func: function): V | undefined

Inherited from BaseCollectionMixin.find
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:9
Parameters
- func: function
  - - (v: V, k: K): boolean
    - Parameters
      - v: V
      - k: K
      Returns boolean
Returns V | undefined

first

first(): V | undefined

Inherited from BaseCollectionMixin.first
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:10
Returns V | undefined

forEach

forEach(func: function, thisArg?: any): void

Inherited from BaseCollection.forEach

Overrides BaseCollectionMixin.forEach
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:48
Parameters
- func: function
  - - (v: V, k: K, map: Map<K, V>): void
    - Parameters
      - v: V
      - k: K
      - map: Map<K, V>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: K): V | undefined

Inherited from BaseCollection.get
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:49
Parameters
- key: K
Returns V | undefined

has

has(key: K): boolean

Inherited from BaseCollection.has
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:50
Parameters
- key: K
Returns boolean

join

join(separator?: undefined | string): string

Inherited from BaseCollectionMixin.join
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:12
Parameters
- Optional separator: undefined | string
Returns string

keys

keys(): IterableIterator<K>

Inherited from BaseCollection.keys

Overrides BaseCollectionMixin.keys
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:51
Returns IterableIterator<K>

map

map(func: function): Array<any>

Inherited from BaseCollectionMixin.map
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:13
Parameters
- func: function
  - - (v: V, k: K): any
    - Parameters
      - v: V
      - k: K
      Returns any
Returns Array<any>

reduce

reduce(func: function, initialValue?: any): any

Inherited from BaseCollectionMixin.reduce
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:14
Parameters
- func: function
  - - (intial: any, v: V): any
    - Parameters
      - intial: any
      - v: V
      Returns any
- Optional initialValue: any
Returns any

set

set(key: K, value: V): this

Inherited from BaseCollection.set
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:52
Parameters
- key: K
- value: V
Returns this

setEnabled

setEnabled(value: boolean): void

- Defined in src/collections/basecollection.ts:195
Parameters
- value: boolean
Returns void

setExpire

setExpire(value: number): this

Inherited from BaseCollection.setExpire
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:40
Parameters
- value: number
Returns this

setIntervalTimeout

setIntervalTimeout(value: number): this

Inherited from BaseCollection.setIntervalTimeout
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:41
Parameters
- value: number
Returns this

some

some(func: function): boolean

Inherited from BaseCollectionMixin.some
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:15
Parameters
- func: function
  - - (v: V, k: K): boolean
    - Parameters
      - v: V
      - k: K
      Returns boolean
Returns boolean

sort

sort(func?: undefined | function): Array<V>

Inherited from BaseCollectionMixin.sort
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:16
Parameters
- Optional func: undefined | function
Returns Array<V>

startInterval

startInterval(): void

Inherited from BaseCollection.startInterval
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:42
Returns void

stopInterval

stopInterval(): void

Inherited from BaseCollection.stopInterval
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:43
Returns void

toArray

toArray(): Array<V>

Inherited from BaseCollectionMixin.toArray
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:17
Returns Array<V>

toJSON

toJSON(): Array<V>

Inherited from BaseCollectionMixin.toJSON
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:18
Returns Array<V>

toString

toString(): string

Inherited from BaseCollectionMixin.toString
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:19
Returns string

values

values(): IterableIterator<V>

Inherited from BaseCollection.values

Overrides BaseCollectionMixin.values
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:53
Returns IterableIterator<V>

Type parameters

K

V

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: ShardClient

Default value options: BaseClientCollectionOptions | boolean = {}

Returns BaseClientCollection

Properties

[Symbol.toStringTag]

Optional _lastUsed

cache

client

enabled

Optional expire

Optional interval

intervalTime

lastUsed

length

limit

shouldStartInterval

size

Methods

[Symbol.iterator]

Returns IterableIterator<[K, V]>

clear

Returns void

clone

Returns BaseCollection<K, V>

delete

Parameters

key: K

Returns boolean

entries

Returns IterableIterator<[K, V]>

every

Parameters

func: function

Parameters

v: V

k: K

Returns boolean

Returns boolean

filter

Parameters

func: function

Parameters

v: V

k: K

Returns boolean

Returns Array<V>

find

Parameters

func: function

Parameters

v: V

k: K

Returns boolean

Returns V | undefined

first

Returns V | undefined

forEach

Parameters

func: function

Parameters

v: V

k: K

map: Map<K, V>

Returns void

Optional thisArg: any

Returns void

get

Parameters

key: K