Class: StarboardsManager


StarboardsManager(client, options)

Manager for starboards

Constructor

new StarboardsManager(client, options)

Parameters:
Name Type Description
client Discord.Client

The Discord Client

options StarboardsManagerOptions

The starboard manager options


Members

(private) _options :StarboardsManagerOptions

The options of this manager

Type:

client :Discord.Client

The Discord client that instantiated this manager

Type:
  • Discord.Client

ready :boolean

Whether this manager is ready

Type:
  • boolean

starboards :Array.<Starboard>

Starboards managed by this manager

Type:

Methods

(async, private) _init()

Inititate the manager


(private) _stringify(obj) → {string}

JSON stringify that supports functions

Parameters:
Name Type Description
obj Object
Returns:
  • Type: string

(async) create(options)

Create a new starboard

Parameters:
Name Type Description
options StarboardOptions

The options of this starboard


(async) delete(deleteStarboard)

Delete a starboard

Parameters:
Name Type Description
deleteStarboard Starboard | number

The ID of the starboard to delete


(async) edit(editStarboard, newOptions)

Edit a starboard

Parameters:
Name Type Description
editStarboard Starboard | number

The ID of the starboard to edit

newOptions StarboardOptions

New edited options for the starboard