Members

static, readonly settings :Settings

classes/settings/Gateway.js, line 15

The Settings class that this gateway is a part of.

readonly cache :Cache

classes/settings/Gateway.js, line 237

The cache created with this instance

readonly client :KomadaClient

classes/settings/Gateway.js, line 200

The client this SettingGateway was created with.

engine :string

classes/settings/Gateway.js, line 27

The provider engine that will handle saving and getting all data for this instance.

readonly provider :Provider

classes/settings/Gateway.js, line 218

The provider this SettingGateway instance uses for the persistent data operations.

readonly resolver :Resolver

classes/settings/Gateway.js, line 209

The resolver instance this SettingGateway uses to parse the data.

readonly schema :Schema

classes/settings/Gateway.js, line 227

The schema this gateway instance is handling.

sql :string

classes/settings/Gateway.js, line 35

If the provider is SQL, this property will ensure data is serialized and deserialized.

readonly type :string

classes/settings/Gateway.js, line 246

The type of settings (or name).

validate :function

classes/settings/Gateway.js, line 41

The function validator for this gateway.

Methods

async create(input)

classes/settings/Gateway.js, line 63

Creates a new entry in the cache.

Parameters:

Name	Type	Description
input	Object | string	An object containing a id property, like discord.js objects, or a string.

async destroy(input)

classes/settings/Gateway.js, line 73

Removes an entry from the cache.

Parameters:

Name	Type	Description
input	Object | string	An object containing a id property, like discord.js objects, or a string.

async ensureCreate(target) → {true}

classes/settings/Gateway.js, line 151

Creates the settings if it did not exist previously.

Parameters:

Name	Type	Description
target	Object | string	An object or string that can be parsed by this instance's resolver.

Returns:

true

get(input) → {Schema}

classes/settings/Gateway.js, line 84

Gets an entry from the cache

Parameters:

Name	Type	Description
input	string	The key you are you looking for.

Returns:

Schema

async init(schema) → {void}

classes/settings/Gateway.js, line 49

Initializes the gateway, creating tables, ensuring the schema exists, and caching values.

Parameters:

Name	Type	Description
schema	Schema	The Schema object, validated from settings.

Returns:

void

async reset(input, key) → {any}

classes/settings/Gateway.js, line 112

Reset a key's value to default from a entry.

Parameters:

Name	Type	Description
input	Object | string	An object containing a id property, like Discord.js objects, or a string.
key	string	The key to reset.

Returns:

any

async sync(inputopt) → {void}

classes/settings/Gateway.js, line 93

Sync either all entries from the provider, or a single one.

Parameters:

Name	Type	Attributes	Default	Description
input	Object | string	<optional>	null	An object containing a id property, like discord.js objects, or a string.

Returns:

void

async update(input, object, guildopt) → {Object}

classes/settings/Gateway.js, line 128

Updates an entry.

Parameters:

Name	Type	Attributes	Default	Description
input	Object | string			An object or string that can be parsed by this instance's resolver.
object	Object			An object with pairs of key/value to update.
guild	Object | string	<optional>	null	A Guild resolvable, useful for when the instance of SG doesn't aim for Guild settings.

Returns:

Object

async updateArray(input, type, key, data, guildopt) → {boolean}

classes/settings/Gateway.js, line 168

Update an array from the a Guild's configuration.

Parameters:

Name	Type	Attributes	Default	Description
input	Object | string			An object containing a id property, like discord.js objects, or a string.
type	string			Either 'add' or 'remove'.
key	string			The key from the Schema.
data	any			The value to be added or removed.
guild	Object | string	<optional>	null	The guild for this setting, useful for when the settings aren't aimed for guilds

Returns:

boolean