SpikeyBot-Discord

Class: WebStats

WebStats

Handles sending the bot's stats to http client requests, and discordbots.org.

new WebStats()

Source:

Extends

Members

<nullable> bot :SpikeyBot

The parent SpikeyBot instance. Defaults to required cache value for autocompletion, updates to current reference at init.
Type:
Inherited From:
Source:

client :Discord~Client

The current bot client. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
  • Discord~Client
Inherited From:
Source:

command :Command

The command object for registering command listeners. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
Inherited From:
Source:

<constant> commit :string

The commit at HEAD at the time this module was loaded. Essentially the version of this submodule.
Type:
  • string
Inherited From:
Source:

common :Common

The common object. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
Inherited From:
Source:

Discord :Discord

The current Discord object instance of the bot. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
  • Discord
Inherited From:
Source:

<abstract> helpMessage :undefined|string|Discord~EmbedBuilder

The help message to show the user in the main help message.
Type:
  • undefined | string | Discord~EmbedBuilder
Inherited From:
Source:

<protected, readonly> initialized :boolean

Has this subModule been initialized yet (Has begin() been called).
Type:
  • boolean
Inherited From:
Source:

<constant> loadTime :number

The time at which this module was loaded for use in checking if the module needs to be reloaded because the file has been modified since loading.
Type:
  • number
Inherited From:
Source:

<abstract, protected> myName :string

The name of this submodule. Used for differentiating in the log. Should be defined before begin().
Type:
  • string
Inherited From:
Overrides:
Source:

<abstract> postPrefix :string

The postfix for the global prefix for this subModule. Must be defined before begin(), otherwise it is ignored.
Type:
  • string
Inherited From:
Source:

<private, inner, constant> apiHosts

The request information for updating our server count on bot list websites.
Default Value:
  • ["{\"protocol\":\"https:\",\"host\":\"top.gg\",\"path\":\"/api/bots/{id}/stats\",\"method\":\"POST\",\"headers\":\"\",\"_data\":\"\",\"_allShards\":false}","{\"protocol\":\"https:\",\"host\":\"discord.bots.gg\",\"path\":\"/api/v1/bots/{id}/stats\",\"method\":\"POST\",\"headers\":\"\",\"_data\":\"\",\"_allShards\":true}","{\"protocol\":\"https:\",\"host\":\"bots.ondiscord.xyz\",\"path\":\"/bot-api/bots/{id}/guilds\",\"method\":\"POST\",\"headers\":\"\",\"_data\":\"\",\"_allShards\":false}"]
Source:

<private, inner, constant> cachedLifespan :number

The amount of time the cached data is considered fresh. Anything longer than this must be re-fetched.
Type:
  • number
Default Value:
  • 5 Minutes
Source:

<private, inner> cachedStats :Main~getAllStats~values

The object storing the previously received stats values.
Type:
Default Value:
  • {}
Source:

<private, inner> cachedTime :number

The timestamp at which the stats were last requested.
Type:
  • number
Source:

<private, inner, constant> postFrequency :number

The amount frequency at which we will post our stats to discordbots.org.
Type:
  • number
Default Value:
  • 12 Hours
Source:

<private, inner> postTimeout :Timeout

The next scheduled event at which to post our stats.
Type:
  • Timeout
Source:

Methods

begin(Discord, client, command, common, bot)

Initialize this submodule.
Parameters:
Name Type Description
Discord Discord The Discord object for the API library.
client Discord~Client The client that represents this bot.
command Command The command instance in which to register command listeners.
common Common Class storing common functions.
bot SpikeyBot The parent SpikeyBot instance.
Inherited From:
Source:

<protected> debug(msg)

Log using common.logDebug, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Source:

end()

Trigger subModule to shutdown and get ready for process terminating.
Inherited From:
Source:

<protected> error(msg)

Log using common.error, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Source:

<protected> initialize()

The function called at the end of begin() for further initialization specific to the subModule. Must be defined before begin() is called.
Inherited From:
Overrides:
Source:

<protected> log(msg)

Log using common.log, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Source:

<abstract> reloadable()

Check if this module is in a state that is ready to be reloaded. If false is returned, this module should not be unloaded and doing such may risk putting the module into an uncontrollable state. This is different from unloadable, which checks if this module can be stopped completely, this checks if the module can be stopped and restarted.
Inherited From:
Source:
See:
  • SubModule~unloadable
Returns:
True if can be reloaded, false if cannot.
Type
boolean

<abstract> save( [opt])

Saves all data to files necessary for saving current state.
Parameters:
Name Type Argument Default Description
opt string <optional>
 'sync' Can be 'async', otherwise defaults to synchronous.
Inherited From:
Source:

<protected> shutdown()

Shutdown and disable this submodule. Removes all event listeners.
Inherited From:
Overrides:
Source:

<abstract> unloadable()

Check if this module is in a state that is ready to be unloaded. If false is returned, this module should not be unloaded and doing such may risk putting the module into an uncontrollable state.
Inherited From:
Source:
See:
  • SubModule~reloadable
Returns:
True if can be unloaded, false if cannot.
Type
boolean

<protected> warn(msg)

Log using common.logWarning, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Source:

<private, inner> getStats(cb)

Fetch the bot's stats.
Parameters:
Name Type Description
cb object The bot's stats as an object.
Source:
See:

<private, inner> handler(req, res)

Handler for all http requests. Always replies to res with JSON encoded bot stats.
Parameters:
Name Type Description
req http.IncomingMessage The client's request.
res http.ServerResponse Our response to the client.
Source:

<private, inner> postUpdatedCount()

Send our latest guild count to discordbots.org via https post request.
Source: