Type Definitions
StarboardOptions
The options for starboards
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
channelID |
Discord.Snowflake | The ID of the channel where starred messages should be sent |
||
emoji |
Discord.EmojiIdentifierResolvable |
<optional> |
"⭐" | The emoji to react with for this starboard |
threshold |
number | The amount of reactions required for this starboard |
||
color |
Discord.ColorResolvable |
<optional> |
"#f0ec0e" | The color of the embed(s) of the starboard messages |
selfStar |
boolean |
<optional> |
false | Whether users can star their own messages |
botStar |
boolean |
<optional> |
false | Whether bots can star messages |
ignoreMembers |
function |
<optional> <nullable> |
null | Ignore star reactions from members who pass this function |
ignoreMessages |
function |
<optional> <nullable> |
null | Ignore star reactions for messages that pass this function |
StarboardsManagerOptions
The starboards manager options
Properties:
| Name | Type | Description |
|---|---|---|
storage |
StorageOptions | The starboards storage options |
default |
StarboardOptions | Default starboard options for new starboards |
StarMessageData
Starboard message data
Properties:
| Name | Type | Description |
|---|---|---|
messageID |
Discord.Snowflake | The ID of the message that was starred |
starMessageID |
Discord.Snowflake | The ID of the starboard post of this message |
stars |
number | The amount of star reactions of this message |
StorageOptions
The starboards storage options
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
type |
"sqlite" | "postgres" | "mysql" | "mssql" | "mariadb" |
<optional> |
"sqlite" | The type/dialect of the database |
file |
string |
<optional> <nullable> |
"./starboards.sqlite" | The path to the storage file (sqlite only) |
name |
string |
<optional> |
"database" | The name of the database |
username |
string |
<optional> |
"user" | The username to login with |
password |
string |
<optional> |
"password" | The password to login with |
host |
string |
<optional> |
"localhost" | The IP of the database host |
port |
string |
<optional> <nullable> |
null | The port of the database |