Members

defaults

classes/settings/Schema.js, line 72

Returns an object containing the keys mapped to their default values.

Methods

add(name, optionsopt) → {Schema}

classes/settings/Schema.js, line 58

Add function that adds a new key into the schema. Only requires that you pass a name and type for the key.

Parameters:

Name	Type	Attributes	Description
name	string		The name of the key you want to add.
options	Schema.Options	<optional>	An object containing extra options for a key.

Returns:

Schema - Returns the schema you are creating so you can chain add calls.

Type Definitions

Options

classes/settings/Schema.js, line 42

Properties:

Name	Type	Description
type	Schema.Types	The type of key you want to add
value	?	The default value to set the key to.
min	number	The minimum number, used for determining string length and amount for number types.
max	number	The maximum number, used for determining string length and amount for number types.
Array	boolean	A boolean indicating whether or not this key should be created and stored as an array.

Types

classes/settings/Schema.js, line 24

All of the valid key types in Komada at the present moment.

Properties:

Name	Type	Description
user	string
channel	string
textChannel	string
voiceChannel	string
guild	string
role	string
boolean	string
string	string
integer	string
float	string
url	string
command	string