Skip to main content

Module: @sapphire/plugin-editable-commands

Functions

free

โ–ธ free(message): boolean

Removes the tracked response for message.

Parameters

NameTypeDescription
messageMessage<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:13


get

โ–ธ get(message): Message | null

Gets the tracked response to message, if any was tracked and was not deleted.

Parameters

NameTypeDescription
messageMessage<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:19


reply

โ–ธ reply(message, options): Promise<Message>

Sends a reply message as a response for message, and tracks it.

Parameters

NameTypeDescription
messageMessage<boolean>The message to replies to.
optionsstring | ReplyMessageOptionsThe options for the message sending, identical to TextBasedChannel#send's options.

Returns

Promise<Message>

The response message.

Defined in

node_modules/@skyra/editable-commands/dist/index.d.ts:33


send

โ–ธ send(message, options): Promise<Message>

Sends a message as a response for message, and tracks it.

Parameters

NameTypeDescription
messageMessage<boolean>The message to replies to.
optionsstring | OptionsThe options for the message sending, identical to TextBasedChannel#send's options.

Returns

Promise<Message>

The response message.

Defined in

node_modules/@skyra/editable-commands/dist/index.d.ts:26


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

NameTypeDescription
messageMessage<boolean>The message to track when editing.
responseMessage<boolean>The response to edit when using send with message.

Returns

void

Defined in

node_modules/@skyra/editable-commands/dist/index.d.ts:7