Reference
Classes
Messagecache

Class: MessageCache

Extends

Constructors

new MessageCache()

new MessageCache(client): MessageCache

Parameters

ParameterType
clientClient

Returns

MessageCache

Overrides

Collection.constructor

Defined in

src/core/cache/MessageCache.ts:8 (opens in a new tab)

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
[toStringTag]readonlystring-Collection.[toStringTag]node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:137
sizereadonlynumberCollection.sizenode_modules/typescript/lib/lib.es2015.collection.d.ts:45
[species]readonlyMapConstructor-Collection.[species]node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:319

Methods

[iterator]()

[iterator](): IterableIterator<[any, any]>

Returns an iterable of entries in the map.

Returns

IterableIterator<[any, any]>

Inherited from

Collection.[iterator]

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:119


clear()

clear(): void

Returns

void

Inherited from

Collection.clear

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:20


delete()

delete(key): boolean

Parameters

ParameterType
keyany

Returns

boolean

true if an element in the Map existed and has been removed, or false if the element does not exist.

Inherited from

Collection.delete

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:24


entries()

entries(): IterableIterator<[any, any]>

Returns an iterable of key, value pairs for every entry in the map.

Returns

IterableIterator<[any, any]>

Inherited from

Collection.entries

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:124


fetch()

fetch(channelId, messageId): Promise<Message>

Parameters

ParameterType
channelIdstring
messageIdstring

Returns

Promise<Message>

Defined in

src/core/cache/MessageCache.ts:16 (opens in a new tab)


first()

first(): Message

Returns

Message

Inherited from

Collection.first

Defined in

src/core/classes/Collection.ts:23 (opens in a new tab)


forEach()

forEach(callbackfn, thisArg?): void

Executes a provided function once per each key/value pair in the Map, in insertion order.

Parameters

ParameterType
callbackfn(value, key, map) => void
thisArg?any

Returns

void

Inherited from

Collection.forEach

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:28


get()

get<V>(key): null | 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.

Type Parameters

Type Parameter
V extends Message

Parameters

ParameterType
keyany

Returns

null | V

Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

Inherited from

Collection.get

Defined in

src/core/classes/Collection.ts:4 (opens in a new tab)


has()

has(key): boolean

Parameters

ParameterType
keyany

Returns

boolean

boolean indicating whether an element with the specified key exists or not.

Inherited from

Collection.has

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:37


keys()

keys(): IterableIterator<any>

Returns an iterable of keys in the map

Returns

IterableIterator<any>

Inherited from

Collection.keys

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:129


last()

last(): Message

Returns

Message

Inherited from

Collection.last

Defined in

src/core/classes/Collection.ts:27 (opens in a new tab)


random()

random(): Message

Returns

Message

Inherited from

Collection.random

Defined in

src/core/classes/Collection.ts:31 (opens in a new tab)


remove()

remove(key): boolean

Parameters

ParameterType
keyany

Returns

boolean

Inherited from

Collection.remove

Defined in

src/core/classes/Collection.ts:15 (opens in a new tab)


set()

set<V>(key, value): V

Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

Type Parameters

Type Parameter
V extends Message

Parameters

ParameterType
keyany
valueV

Returns

V

Inherited from

Collection.set

Defined in

src/core/classes/Collection.ts:9 (opens in a new tab)


toArray()

toArray(): Message[]

Returns

Message[]

Inherited from

Collection.toArray

Defined in

src/core/classes/Collection.ts:19 (opens in a new tab)


values()

values(): IterableIterator<any>

Returns an iterable of values in the map

Returns

IterableIterator<any>

Inherited from

Collection.values

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:134