ClientStorage

Class containing asynchronous methods for storing, retrieving, and interacting with data specific to the Client instance. Can not be created directly via a constructor due to mixin mechanics. Created internally via StorageFactory#createClientStorage

Constructor

new ClientStorage()

Mixes In:
Source:

Properties

.guilds: Collection<string, GuildStorage>

Collection mapping Guild IDs to GuildStorages

Type:
Collection<string, GuildStorage>
Source:

Methods

.clear() → Promise<void>

Remove all key/value pairs from this storage

Source:
Returns:
Promise<void>

.get(key: string) → Promise<any>

Get a value from this storage for the specified key

Parameters:
Name Type Description
key
string

The key in storage to get
Source:
Returns:
Promise<any>

.init() → Promise<void>

Initialize this storage. Any other method calls should not be made until this method has been called and resolved

Source:
Returns:
Promise<void>

.keys() → Promise<string[]>

Get the names of all keys in this storage

Source:
Returns:
Promise<string[]>

.remove(key: string) → Promise<void>

Remove a key/value pair from this storage

Parameters:
Name Type Description
key
string

The key in storage to remove
Source:
Returns:
Promise<void>

.set(key: string, value: any) → Promise<void>

Set a value in this storage for the specified key

Parameters:
Name Type Description
key
string

The key in storage to set
value
any

The value to set
Source:
Returns:
Promise<void>