From 214a8ebb19ddace8e9796439dadd4b8a4dadb309 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 7 Sep 2024 00:54:46 +0000 Subject: [PATCH] deploy: 868df39ac0c0ebff6b0db717934a36fce51701b8 --- ...d_context.ChatInputCommandInteractionContext.html | 4 ++-- .../_stegripe_command_context.CommandContext.html | 4 ++-- ...pe_command_context.CommandInteractionContext.html | 4 ++-- .../_stegripe_command_context.ContextCommand.html | 12 ++++++------ ...stegripe_command_context.ContextPrecondition.html | 8 ++++---- .../_stegripe_command_context.MessageContext.html | 4 ++-- ....MessageContextMenuCommandInteractionContext.html | 4 ++-- ...ext.UserContextMenuCommandInteractionContext.html | 4 ++-- classes/_stegripe_pino_logger.PinoLogger.html | 8 ++++---- 9 files changed, 26 insertions(+), 26 deletions(-) diff --git a/classes/_stegripe_command_context.ChatInputCommandInteractionContext.html b/classes/_stegripe_command_context.ChatInputCommandInteractionContext.html index 0e034a9..18d54b4 100644 --- a/classes/_stegripe_command_context.ChatInputCommandInteractionContext.html +++ b/classes/_stegripe_command_context.ChatInputCommandInteractionContext.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #efe7de; --md-sys-color-surface-container-highest: #e9e1d9 } -

Class ChatInputCommandInteractionContext

Hierarchy (view full)

Constructors

constructor +

Class ChatInputCommandInteractionContext

Hierarchy (view full)

Constructors

constructor

Properties

context

Accessors

appPermissions applicationId @@ -226,7 +226,7 @@ toJSON toString valueOf -

Constructors

constructor

Properties

Readonlycontext

context: ChatInputCommandInteraction<CacheType>

Accessors

appPermissions

applicationId

author

channel

channelId

client

command

commandGuildId

commandId

commandName

commandType

createdAt

createdTimestamp

deferred

entitlements

ephemeral

guild

guildId

guildLocale

id

locale

member

memberPermissions

options

replied

token

type

user

version

webhook

Methods

awaitModalSubmit

deferReply

deleteReply

editReply

fetchReply

followUp

inCachedGuild

inGuild

inRawGuild

isAnySelectMenu

isAutocomplete

isButton

isChannelSelectMenu

isChatInputCommand

isChatInputInteractionContext

isCommand

isCommandInteraction

isContextMenuCommand

isMentionableSelectMenu

isMessageComponent

isMessageContext

isMessageContextMenuCommand

isMessageContextMenuInteractionContext

isModalSubmit

isRepliable

isRoleSelectMenu

isSelectMenu

isStringSelectMenu

isUserContextMenuCommand

isUserContextMenuInteractionContext

isUserSelectMenu

reply

send

sendPremiumRequired

showModal

toJSON

toString

valueOf

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods

Class CommandContext

Hierarchy (view full)

Constructors

constructor +

Class CommandContext

Hierarchy (view full)

Constructors

constructor

Properties

context

Accessors

applicationId author @@ -181,7 +181,7 @@ toJSON toString valueOf -

Constructors

constructor

Properties

Readonlycontext

context: CommandInteraction<CacheType> | Message<boolean>

Accessors

applicationId

author

channel

channelId

client

createdAt

createdTimestamp

guild

guildId

id

member

type

Methods

inGuild

isChatInputInteractionContext

isCommandInteraction

isMessageContext

isMessageContextMenuInteractionContext

isUserContextMenuInteractionContext

reply

send

toJSON

toString

valueOf

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods

Class CommandInteractionContext

Hierarchy (view full)

Constructors

constructor +

Class CommandInteractionContext

Hierarchy (view full)

Constructors

constructor

Properties

context

Accessors

appPermissions applicationId @@ -226,7 +226,7 @@ toJSON toString valueOf -

Constructors

constructor

Properties

Readonlycontext

context: CommandInteraction<CacheType>

Accessors

appPermissions

applicationId

author

channel

channelId

client

command

commandGuildId

commandId

commandName

commandType

createdAt

createdTimestamp

deferred

entitlements

ephemeral

guild

guildId

guildLocale

id

locale

member

memberPermissions

options

  • get options(): Omit<CommandInteractionOptionResolver<CacheType>,
        | "getMessage"
        | "getFocused"
        | "getSubcommand"
        | "getSubcommandGroup"
        | "getBoolean"
        | "getChannel"
        | "getString"
        | "getInteger"
        | "getNumber"
        | "getUser"
        | "getMember"
        | "getRole"
        | "getAttachment"
        | "getMentionable">

  • Returns Omit<CommandInteractionOptionResolver<CacheType>,
        | "getMessage"
        | "getFocused"
        | "getSubcommand"
        | "getSubcommandGroup"
        | "getBoolean"
        | "getChannel"
        | "getString"
        | "getInteger"
        | "getNumber"
        | "getUser"
        | "getMember"
        | "getRole"
        | "getAttachment"
        | "getMentionable">

replied

token

type

user

version

webhook

Methods

awaitModalSubmit

deferReply

deleteReply

editReply

fetchReply

followUp

inCachedGuild

inGuild

inRawGuild

isAnySelectMenu

isAutocomplete

isButton

isChannelSelectMenu

isChatInputCommand

isChatInputInteractionContext

isCommand

isCommandInteraction

isContextMenuCommand

isMentionableSelectMenu

isMessageComponent

isMessageContext

isMessageContextMenuCommand

isMessageContextMenuInteractionContext

isModalSubmit

isRepliable

isRoleSelectMenu

isSelectMenu

isStringSelectMenu

isUserContextMenuCommand

isUserContextMenuInteractionContext

isUserSelectMenu

reply

send

sendPremiumRequired

showModal

toJSON

toString

valueOf

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods

Class ContextCommandAbstract

Hierarchy

  • Command
    • ContextCommand

Constructors

constructor +

Class ContextCommandAbstract

Hierarchy

  • Command
    • ContextCommand

Constructors

constructor

Properties

aliases applicationCommandRegistry chatInputCommand? @@ -201,10 +201,10 @@ toJSON unload runInTypeIsSpecificsObject -

Constructors

constructor

Properties

aliases

aliases: readonly string[]

The aliases for the piece.

+

Constructors

constructor

Properties

aliases

aliases: readonly string[]

The aliases for the piece.

ReadonlyapplicationCommandRegistry

applicationCommandRegistry: ApplicationCommandRegistry

The application command registry associated with this command.

Since

3.0.0

-

OptionalchatInputCommand

chatInputCommand?: SlashCommandBuilder

OptionalcontextMenuCommand

contextMenuCommand?: ContextMenuCommandBuilder

description

description: string

A basic summary about the command

+

OptionalchatInputCommand

chatInputCommand?: SlashCommandBuilder

OptionalcontextMenuCommand

contextMenuCommand?: ContextMenuCommandBuilder

description

description: string

A basic summary about the command

Since

1.0.0

detailedDescription

detailedDescription: DetailedDescriptionCommand

Longer version of command's summary and how to use it

Since

1.0.0

@@ -256,16 +256,16 @@

Parameters

Returns unknown

chatInputRun

contextMenuRun

  • contextMenuRun(interaction): unknown

  • Executes the context menu's logic.

    +

Returns unknown

contextMenuRun

AbstractcontextRun

messagePreParse

  • messagePreParse(message, parameters, context): Awaitable<Args>

  • The message pre-parse method. This method can be overridden by plugins to define their own argument parser.

    +

Returns unknown

AbstractcontextRun

messagePreParse

  • messagePreParse(message, parameters, context): Awaitable<Args>

  • The message pre-parse method. This method can be overridden by plugins to define their own argument parser.

    Parameters

    • message: Message<boolean>

      The message that triggered the command.

    • parameters: string

      The raw parameters as a single string.

    • context: MessageCommandContext

      The command-context used in this execution.

    Returns Awaitable<Args>

messageRun

onLoad

  • onLoad(): unknown

  • Per-piece listener that is called when the piece is loaded into the store. +

Returns unknown

onLoad

  • onLoad(): unknown

  • Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.

    Returns unknown

onUnload

  • onUnload(): unknown

  • Per-piece listener that is called when the piece is unloaded from the store. Useful to set-up clean-up tasks.

    diff --git a/classes/_stegripe_command_context.ContextPrecondition.html b/classes/_stegripe_command_context.ContextPrecondition.html index a598ca6..d6d73f8 100644 --- a/classes/_stegripe_command_context.ContextPrecondition.html +++ b/classes/_stegripe_command_context.ContextPrecondition.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #efe7de; --md-sys-color-surface-container-highest: #e9e1d9 } -

    Class ContextPreconditionAbstract

    Hierarchy

    • Precondition
      • ContextPrecondition

    Constructors

    constructor +

    Class ContextPreconditionAbstract

    Hierarchy

    • Precondition
      • ContextPrecondition

    Constructors

    constructor

    Properties

    enabled location name @@ -176,16 +176,16 @@ reload toJSON unload -

    Constructors

    constructor

    Properties

    enabled

    enabled: boolean

    Whether or not the piece is enabled.

    +

    Constructors

    constructor

    Properties

    enabled

    enabled: boolean

    Whether or not the piece is enabled.

    Readonlylocation

    location: PieceLocation

    The location metadata for the piece's file.

    Readonlyname

    name: string

    The name of the piece.

    Readonlyoptions

    options: PreconditionOptions

    The raw options passed to this Piece

    Readonlyposition

    position: null | number

    Readonlystore

    store: PreconditionStore

    The store that contains the piece.

    Accessors

    container

    • get container(): Container

    • A reference to the Container object for ease of use.

      Returns Container

      See

      container

      -

    Methods

    chatInputRun

    contextMenuRun

    AbstractcontextRun

    error

    • error(options?): PreconditionResult

    • Constructs a PreconditionError with the precondition parameter set to this.

      +

    Methods

    chatInputRun

    contextMenuRun

    AbstractcontextRun

    error

    • error(options?): PreconditionResult

    • Constructs a PreconditionError with the precondition parameter set to this.

      Parameters

      • Optionaloptions: Omit<Options, "precondition">

        The information.

        -

      Returns PreconditionResult

    ProtectedfetchChannelFromInteraction

    messageRun

    ok

    • ok(): PreconditionResult

    • Returns PreconditionResult

    onLoad

    • onLoad(): unknown

    • Per-piece listener that is called when the piece is loaded into the store. +

    Returns PreconditionResult

ProtectedfetchChannelFromInteraction

messageRun

ok

  • ok(): PreconditionResult

  • Returns PreconditionResult

onLoad

  • onLoad(): unknown

  • Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.

    Returns unknown

onUnload

  • onUnload(): unknown

  • Per-piece listener that is called when the piece is unloaded from the store. Useful to set-up clean-up tasks.

    diff --git a/classes/_stegripe_command_context.MessageContext.html b/classes/_stegripe_command_context.MessageContext.html index 4bcdf28..b562bbc 100644 --- a/classes/_stegripe_command_context.MessageContext.html +++ b/classes/_stegripe_command_context.MessageContext.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #efe7de; --md-sys-color-surface-container-highest: #e9e1d9 } -

    Class MessageContext

    Hierarchy (view full)

    Constructors

    constructor +

    Class MessageContext

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    args? context

    Accessors

    activity @@ -233,7 +233,7 @@ toString unpin valueOf -

    Constructors

    constructor

    Properties

    Optional Readonlyargs

    args?: Args

    Readonlycontext

    context: Message<boolean>

    Accessors

    activity

    applicationId

    attachments

    author

    bulkDeletable

    channel

    channelId

    cleanContent

    client

    components

    content

    createdAt

    createdTimestamp

    crosspostable

    deletable

    editable

    editedAt

    editedTimestamp

    embeds

    flags

    groupActivityApplication

    guild

    guildId

    hasThread

    id

    interaction

    member

    mentions

    nonce

    partial

    pinnable

    pinned

    poll

    position

    reactions

    reference

    resolved

    roleSubscriptionData

    stickers

    system

    thread

    tts

    type

    url

    webhookId

    Methods

    awaitMessageComponent

    awaitReactions

    createMessageComponentCollector

    createReactionCollector

    crosspost

    delete

    edit

    equals

    fetch

    fetchReference

    fetchWebhook

    inGuild

    isChatInputInteractionContext

    isCommandInteraction

    isMessageContext

    isMessageContextMenuInteractionContext

    isUserContextMenuInteractionContext

    pin

    react

    removeAttachments

    reply

    resolveComponent

    send

    startThread

    suppressEmbeds

    toJSON

    toString

    unpin

    valueOf

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods

    Class MessageContextMenuCommandInteractionContext

    Hierarchy (view full)

    Constructors

    constructor +

    Class MessageContextMenuCommandInteractionContext

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    context

    Accessors

    appPermissions applicationId @@ -228,7 +228,7 @@ toJSON toString valueOf -

    Constructors

    constructor

    Properties

    Readonlycontext

    context: MessageContextMenuCommandInteraction<CacheType>

    Accessors

    appPermissions

    applicationId

    author

    channel

    channelId

    client

    command

    commandGuildId

    commandId

    commandName

    commandType

    createdAt

    createdTimestamp

    deferred

    entitlements

    ephemeral

    guild

    guildId

    guildLocale

    id

    locale

    member

    memberPermissions

    options

    replied

    targetId

    targetMessage

    token

    type

    user

    version

    webhook

    Methods

    awaitModalSubmit

    deferReply

    deleteReply

    editReply

    fetchReply

    followUp

    inCachedGuild

    inGuild

    inRawGuild

    isAnySelectMenu

    isAutocomplete

    isButton

    isChannelSelectMenu

    isChatInputCommand

    isChatInputInteractionContext

    isCommand

    isCommandInteraction

    isContextMenuCommand

    isMentionableSelectMenu

    isMessageComponent

    isMessageContext

    isMessageContextMenuCommand

    isMessageContextMenuInteractionContext

    isModalSubmit

    isRepliable

    isRoleSelectMenu

    isSelectMenu

    isStringSelectMenu

    isUserContextMenuCommand

    isUserContextMenuInteractionContext

    isUserSelectMenu

    reply

    send

    sendPremiumRequired

    showModal

    toJSON

    toString

    valueOf

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods

    Class UserContextMenuCommandInteractionContext

    Hierarchy (view full)

    Constructors

    constructor +

    Class UserContextMenuCommandInteractionContext

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    context

    Accessors

    appPermissions applicationId @@ -229,7 +229,7 @@ toJSON toString valueOf -

    Constructors

    constructor

    Properties

    Readonlycontext

    context: UserContextMenuCommandInteraction<CacheType>

    Accessors

    appPermissions

    applicationId

    author

    channel

    channelId

    client

    command

    commandGuildId

    commandId

    commandName

    commandType

    createdAt

    createdTimestamp

    deferred

    entitlements

    ephemeral

    guild

    guildId

    guildLocale

    id

    locale

    member

    memberPermissions

    options

    replied

    targetId

    targetMember

    targetUser

    token

    type

    user

    version

    webhook

    Methods

    awaitModalSubmit

    deferReply

    deleteReply

    editReply

    fetchReply

    followUp

    inCachedGuild

    inGuild

    inRawGuild

    isAnySelectMenu

    isAutocomplete

    isButton

    isChannelSelectMenu

    isChatInputCommand

    isChatInputInteractionContext

    isCommand

    isCommandInteraction

    isContextMenuCommand

    isMentionableSelectMenu

    isMessageComponent

    isMessageContext

    isMessageContextMenuCommand

    isMessageContextMenuInteractionContext

    isModalSubmit

    isRepliable

    isRoleSelectMenu

    isSelectMenu

    isStringSelectMenu

    isUserContextMenuCommand

    isUserContextMenuInteractionContext

    isUserSelectMenu

    reply

    send

    sendPremiumRequired

    showModal

    toJSON

    toString

    valueOf

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods

    Class PinoLogger

    Hierarchy

    • Logger
      • PinoLogger

    Constructors

    constructor +

    Class PinoLogger

    Hierarchy

    • Logger
      • PinoLogger

    Constructors

    constructor

    Properties

    level pino levels @@ -168,19 +168,19 @@ trace warn write -

    Constructors

    constructor

    Properties

    level

    level: LogLevel

    Readonlypino

    pino: Logger

    Protected Static Readonlylevels

    levels: Map<LogLevel, LogMethods>

    Methods

    debug

    • debug(...values): void

    • Alias of ILogger.write with LogLevel.Debug as level.

      +

    Constructors

    constructor

    Properties

    level

    level: LogLevel

    Readonlypino

    pino: Logger

    Protected Static Readonlylevels

    levels: Map<LogLevel, LogMethods>

    Methods

    debug

    • debug(...values): void

    • Alias of ILogger.write with LogLevel.Debug as level.

      Parameters

      • Rest...values: readonly unknown[]

        The values to log.

      Returns void

    error

    • error(...values): void

    • Alias of ILogger.write with LogLevel.Error as level.

      Parameters

      • Rest...values: readonly unknown[]

        The values to log.

      Returns void

    fatal

    • fatal(...values): void

    • Alias of ILogger.write with LogLevel.Fatal as level.

      Parameters

      • Rest...values: readonly unknown[]

        The values to log.

        -

      Returns void

    has

    info

    • info(...values): void

    • Alias of ILogger.write with LogLevel.Info as level.

      +

    Returns void

has

info

  • info(...values): void

  • Alias of ILogger.write with LogLevel.Info as level.

    Parameters

    • Rest...values: readonly unknown[]

      The values to log.

    Returns void

trace

  • trace(...values): void

  • Alias of ILogger.write with LogLevel.Trace as level.

    Parameters

    • Rest...values: readonly unknown[]

      The values to log.

    Returns void

warn

  • warn(...values): void

  • Alias of ILogger.write with LogLevel.Warn as level.

    Parameters

    • Rest...values: readonly unknown[]

      The values to log.

      -

    Returns void

write

Settings

Member Visibility

On This Page

Constructors
Properties
Methods