Module: @sapphire/plugin-editable-commands
Type Aliases
MessageOptions
Ƭ MessageOptions: MessageCreateOptions | MessageReplyOptions | MessageEditOptions
Defined in
node_modules/@skyra/editable-commands/dist/index.d.ts:3
Variables
version
• Const version: string = '[VI]{{inject}}[/VI]'
The @sapphire/plugin-editable-commands version that you are currently using. An example use of this is showing it of in a bot information command.
Note to Sapphire developers: This needs to explicitly be string so it is not typed as the string that gets replaced by esbuild
Defined in
projects/plugins/packages/editable-commands/src/index.ts:13
Functions
free
▸ free(message): boolean
Removes the tracked response for message.
Parameters
| Name | Type | Description |
|---|---|---|
message | Message<boolean> | The message to free from tracking. |
Returns
boolean
Whether the message was tracked.
Defined in
node_modules/@skyra/editable-commands/dist/index.d.ts:15
get
▸ get(message): Message | null
Gets the tracked response to message, if any was tracked and was not deleted.
Parameters
| Name | Type | Description |
|---|---|---|
message | Message<boolean> | The message to get the reply from. |
Returns
Message | null
The replied message, if any.
Defined in
node_modules/@skyra/editable-commands/dist/index.d.ts:21
loadListeners
▸ loadListeners(): void
Returns
void
Defined in
projects/plugins/packages/editable-commands/src/listeners/_load.ts:4
reply
▸ reply(message, options): Promise<Message>
Sends a reply message as a response for message, and tracks it.
Parameters
| Name | Type | Description |
|---|---|---|
message | Message<boolean> | The message to replies to. |
options | string | MessageOptions | The options for the message sending, identical to TextBasedChannel#send's options. |
Returns
The response message.
Defined in
node_modules/@skyra/editable-commands/dist/index.d.ts:35
send
▸ send(message, options): Promise<Message>
Sends a message as a response for message, and tracks it.
Parameters
| Name | Type | Description |
|---|---|---|
message | Message<boolean> | The message to replies to. |
options | string | MessageOptions | The options for the message sending, identical to TextBasedChannel#send's options. |
Returns
The response message.
Defined in
node_modules/@skyra/editable-commands/dist/index.d.ts:28
track
▸ track(message, response): void
Tracks a response with a message, in a way that if send is called with message, response will be edited.
Parameters
| Name | Type | Description |
|---|---|---|
message | Message<boolean> | The message to track when editing. |
response | Message<boolean> | The response to edit when using send with message. |
Returns
void
Defined in
node_modules/@skyra/editable-commands/dist/index.d.ts:9