Global

Type Definitions

ClientOptions

The options supplied on instantiating the client.

Type:

object

Properties:

Name	Type	Attributes	Default	Description
`guildToken`	string	<optional>		The guild's API Token from the site. Required for some endpoints.
`guildID`	string	<optional>		The guild's ID.
`cache`	boolean	<optional>	false	Whether or not to cache guilds/users on fetch.
`version`	number	<optional>	1	The default version of the API to use when fetching and posting.

Source:

structures/options.js, line 1

FetchOptions

Options available to pass when fetching something, etc. a guild.

Type:

object

Properties:

Name	Type	Attributes	Default	Description
`cache`	boolean	<optional>	this.options.cache	When set to true, caches the fetched object into a Store. Corrosponds to ClientOptions#cache when not present while fetching.
`version`	boolean	<optional>	this.options.version	The version to use to fetch an endpoint.
`raw`	boolean	<optional>	false	When set to true, returns the raw fetched object.
`guildToken`	string	<optional>	this.options.guildToken	One of your guild's authorization token from the site.

Source:

structures/options.js, line 15

MultiFetchOptions

Options when a given output is an array.

Type:

object

Properties:

Name	Type	Attributes	Default	Description
`cache`	boolean	<optional>	this.options.cache	When set to true, caches the fetched object into a Store/Set value. Corrosponds to ClientOptions#cache when not present while fetching.
`raw`	boolean	<optional>	false	When set to true, returns the raw fetched object.
`version`	boolean	<optional>	this.options.version	The version to use to fetch an endpoint.
`mapify`	boolean	<optional>	true	When set to true, the fetched value will be in a Store, mapped by their IDs.
`guildToken`	string	<optional>	this.options.guildToken	One of your guild's authorization token from the site.
`page`	number	<optional>	1	The section of the endpoint to take.

Source:

structures/options.js, line 30