Interface ComponentPop<TState, TInput, TLocals>

The full execution context provided to command and snap handlers.

Extends EventPop with interaction-specific members: reply(), defer(), options (typed slash command arguments), input (schema-validated input), and references to the raw interaction and message objects.

Use the TInput type parameter when you supply a schema to the command — the validated result is then available as pop.input with full type inference.

Example: Reply with an embed

async do(pop) {
  await pop.reply({
    embeds: [{ title: "Hello!", description: `Hey ${pop.user.username}` }],
    ephemeral: true
  });
}

Example: Defer a slow command

async do(pop) {
  await pop.defer();
  const result = await someSlowOperation();
  await pop.reply(result);
}

interface ComponentPop<
    TState = any,
    TInput = any,
    TLocals = PopiiLocals & Record<string, any>,
> {
    ai: {
        generate(prompt: string): Promise<string>;
        chat(
            history: { role: "user" | "system" | "assistant"; content: string }[],
        ): Promise<string>;
    };
    canvas: {
        create(width: number, height: number): Promise<CanvasBuilder>;
        nowPlayingCard(
            track: NowPlayingTrack,
            opts?: NowPlayingCardOptions,
        ): Promise<AttachmentBuilder>;
    };
    captcha: { sendVerificationPanel(channelId: string): Promise<void> };
    desk: {
        sendPanel(channelId: string): Promise<void>;
        closeTicket(): Promise<void>;
    };
    economy: {
        currencyName: string;
        getProfile(
            userId: string,
        ): Promise<
            | { xp: number; level: number; balance: number; last_daily: number }
            | null,
        >;
        addXp(userId: string, amount: number): Promise<boolean>;
        addBalance(userId: string, amount: number): Promise<void>;
    };
    giveaways: {
        start(
            channelId: string,
            prize: string,
            winners: number,
            durationMs: number,
        ): Promise<void>;
    };
    lastfm: {
        getAccount(
            userId: string,
        ): Promise<{ username: string; sessionKey: string } | null>;
    };
    mongoose: __module;
    db: Database;
    success(message: string): Promise<void>;
    error(message: string): Promise<void>;
    info(message: string): Promise<void>;
    paginate(
        source:
            | EmbedBuilder[]
            | {
                fetch: (page: number) => Promise<EmbedBuilder | null>;
                totalPages?: number;
            },
        timeoutMs?: number,
    ): Promise<void>;
    prompt(
        embed: EmbedBuilder,
        buttons: string[],
        timeoutMs?: number,
    ): Promise<string | null>;
    form(
        title: string,
        fields: FormField[],
        timeoutMs?: number,
    ): Promise<Record<string, string> | null>;
    awaitMessage(timeoutMs?: number, promptMessageId?: string): Promise<any>;
    wizard(
        steps: WizardStep[],
        timeoutMs?: number,
    ): Promise<Record<string, string> | null>;
    joinVoice(): Promise<any>;
    playAudio(
        urlOrStream: any,
    ): Promise<{ player: any; title: string; metadata?: any }>;
    leaveVoice(): Promise<void>;
    getQueue(): any[];
    getNowPlaying(): | {
        title: string;
        artist: string;
        duration: string;
        thumbnail?: string;
        requestedBy?: string;
        elapsedMs: number;
        elapsed: string;
        progress: number;
    }
    | null;
    getNowPlayingCard(
        opts?: { accentColor?: string },
    ): Promise<AttachmentBuilder | null>;
    sponsorblock: {
        isEnabled(): boolean;
        setEnabled(enabled: boolean): void;
        getCategories(): string[];
        setCategories(cats: string[]): void;
        forceSkip(): Promise<boolean>;
    };
    client: PopiiClient<TState>;
    locale: string;
    log: PopLogger;
    createAttachment(path: string, name?: string): any;
    fetchJSON<T = unknown>(
        url: string | Request | URL,
        init?: RequestInit,
    ): Promise<T>;
    fetchText(url: string | Request | URL, init?: RequestInit): Promise<string>;
    fetchBuffer(
        url: string | Request | URL,
        init?: RequestInit,
    ): Promise<ArrayBuffer>;
    fetchForm<T = unknown>(
        url: string | Request | URL,
        data: FormData,
        init?: RequestInit,
    ): Promise<T>;
    cache<T>(
        key: string,
        ttlMs: number,
        fetcher: () => T | Promise<T>,
    ): Promise<T>;
    translate(key: string, args?: Record<string, any>): string;
    t(key: string, args?: Record<string, any>): string;
    cooler: {
        get<T = any>(key: string): Promise<T | null>;
        set(key: string, value: any, ttlMs?: number): Promise<void>;
        delete(key: string): Promise<void>;
    };
    pack(customId: string, data: any): string;
    state: TState;
    locals: TLocals;
    guild: Guild | null;
    channel: TextBasedChannel | null;
    schedule(taskName: string, payload?: any, delayMs?: number): Promise<void>;
    reply(
        payload:
            | string
            | {
                content?: string;
                embeds?: any[];
                components?: any[];
                files?: any[];
                ephemeral?: boolean;
            },
    ): Promise<any>;
    defer(options?: { ephemeral?: boolean }): Promise<void>;
    respond(choices: { name: string; value: string | number }[]): Promise<void>;
    respondFiltered(
        choices: { name: string; value: string | number }[],
        userInput: string,
    ): Promise<void>;
    user: User;
    member: GuildMember | APIInteractionGuildMember | null;
    options: PopOptions;
    input: TInput;
    snapMatches?: RegExpMatchArray | null;
    snapData?: any;
    targetMessage?: Message<boolean> | null;
    targetUser?: User | null;
    interaction:
        | ModalSubmitInteraction<CacheType>
        | MessageComponentInteraction<CacheType>;
    message: Message<boolean>;
}

Type Parameters

TState = any
TInput = any
TLocals = PopiiLocals & Record<string, any>

Hierarchy (View Summary)

Pop<TState, TInput, TLocals>
- ComponentPop

Methods

success

success(message: string): Promise<void>
Parameters
- message: string
Returns Promise<void>
Inherited from Pop.success
- Defined in plugins/ui.ts:22

error

error(message: string): Promise<void>
Parameters
- message: string
Returns Promise<void>
Inherited from Pop.error
- Defined in plugins/ui.ts:23

info

info(message: string): Promise<void>
Parameters
- message: string
Returns Promise<void>
Inherited from Pop.info
- Defined in plugins/ui.ts:24

paginate

paginate(
    source:
        | EmbedBuilder[]
        | {
            fetch: (page: number) => Promise<EmbedBuilder | null>;
            totalPages?: number;
        },
    timeoutMs?: number,
): Promise<void>
Parameters
- source:
      | EmbedBuilder[]
      | {
          fetch: (page: number) => Promise<EmbedBuilder | null>;
          totalPages?: number;
      }
- OptionaltimeoutMs: number
Returns Promise<void>
Inherited from Pop.paginate
- Defined in plugins/ui.ts:25

prompt

prompt(
    embed: EmbedBuilder,
    buttons: string[],
    timeoutMs?: number,
): Promise<string | null>
Parameters
- embed: EmbedBuilder
- buttons: string[]
- OptionaltimeoutMs: number
Returns Promise<string | null>
Inherited from Pop.prompt
- Defined in plugins/ui.ts:26

form

form(
    title: string,
    fields: FormField[],
    timeoutMs?: number,
): Promise<Record<string, string> | null>
Parameters
- title: string
- fields: FormField[]
- OptionaltimeoutMs: number
Returns Promise<Record<string, string> | null>
Inherited from Pop.form
- Defined in plugins/ui.ts:27

awaitMessage

awaitMessage(timeoutMs?: number, promptMessageId?: string): Promise<any>
Parameters
- OptionaltimeoutMs: number
- OptionalpromptMessageId: string
Returns Promise<any>
Inherited from Pop.awaitMessage
- Defined in plugins/ui.ts:28

wizard

wizard(
steps: WizardStep[],
timeoutMs?: number,
): Promise<Record<string, string> | null>
Parameters
- steps: WizardStep[]
- OptionaltimeoutMs: number
Returns Promise<Record<string, string> | null>
Inherited from Pop.wizard
- Defined in plugins/ui.ts:29

joinVoice

joinVoice(): Promise<any>
Returns Promise<any>
Inherited from Pop.joinVoice
- Defined in plugins/voice.ts:8

playAudio

playAudio(
urlOrStream: any,
): Promise<{ player: any; title: string; metadata?: any }>
Parameters
- urlOrStream: any
Returns Promise<{ player: any; title: string; metadata?: any }>
Inherited from Pop.playAudio
- Defined in plugins/voice.ts:9

leaveVoice

leaveVoice(): Promise<void>
Returns Promise<void>
Inherited from Pop.leaveVoice
- Defined in plugins/voice.ts:10

getQueue

getQueue(): any[]
Returns any[]
Inherited from Pop.getQueue
- Defined in plugins/voice.ts:11

getNowPlaying

getNowPlaying(): | {
    title: string;
    artist: string;
    duration: string;
    thumbnail?: string;
    requestedBy?: string;
    elapsedMs: number;
    elapsed: string;
    progress: number;
}
| null
Returns
    | {
        title: string;
        artist: string;
        duration: string;
        thumbnail?: string;
        requestedBy?: string;
        elapsedMs: number;
        elapsed: string;
        progress: number;
    }
    | null
Inherited from Pop.getNowPlaying
- Defined in plugins/voice.ts:12

getNowPlayingCard

getNowPlayingCard(
opts?: { accentColor?: string },
): Promise<AttachmentBuilder | null>
Parameters
- Optionalopts: { accentColor?: string }
Returns Promise<AttachmentBuilder | null>
Inherited from Pop.getNowPlayingCard
- Defined in plugins/voice.ts:13

createAttachment

createAttachment(path: string, name?: string): any
Parameters
- path: string
- Optionalname: string
Returns any
Inherited from Pop.createAttachment
- Defined in types.ts:124

fetchJSON

fetchJSON<T = unknown>(
url: string | Request | URL,
init?: RequestInit,
): Promise<T>
Type Parameters
- T = unknown
Parameters
- url: string | Request | URL
- Optionalinit: RequestInit
Returns Promise<T>
Inherited from Pop.fetchJSON
- Defined in types.ts:125

fetchText

fetchText(url: string | Request | URL, init?: RequestInit): Promise<string>
Parameters
- url: string | Request | URL
- Optionalinit: RequestInit
Returns Promise<string>
Inherited from Pop.fetchText
- Defined in types.ts:126

fetchBuffer

fetchBuffer(
url: string | Request | URL,
init?: RequestInit,
): Promise<ArrayBuffer>
Parameters
- url: string | Request | URL
- Optionalinit: RequestInit
Returns Promise<ArrayBuffer>
Inherited from Pop.fetchBuffer
- Defined in types.ts:127

fetchForm

fetchForm<T = unknown>(
    url: string | Request | URL,
    data: FormData,
    init?: RequestInit,
): Promise<T>
Type Parameters
- T = unknown
Parameters
- url: string | Request | URL
- data: FormData
- Optionalinit: RequestInit
Returns Promise<T>
Inherited from Pop.fetchForm
- Defined in types.ts:128

cache

cache<T>(key: string, ttlMs: number, fetcher: () => T | Promise<T>): Promise<T>
Type Parameters
- T
Parameters
- key: string
- ttlMs: number
- fetcher: () => T | Promise<T>
Returns Promise<T>
Inherited from Pop.cache
- Defined in types.ts:129

translate

translate(key: string, args?: Record<string, any>): string
Parameters
- key: string
- Optionalargs: Record<string, any>
Returns string
Inherited from Pop.translate
- Defined in types.ts:130

t

t(key: string, args?: Record<string, any>): string
Parameters
- key: string
- Optionalargs: Record<string, any>
Returns string
Inherited from Pop.t
- Defined in types.ts:131

pack

pack(customId: string, data: any): string
Parameters
- customId: string
- data: any
Returns string
Inherited from Pop.pack
- Defined in types.ts:137

schedule

schedule(taskName: string, payload?: any, delayMs?: number): Promise<void>
Parameters
- taskName: string
- Optionalpayload: any
- OptionaldelayMs: number
Returns Promise<void>
Inherited from Pop.schedule
- Defined in types.ts:142

reply

reply(
    payload:
        | string
        | {
            content?: string;
            embeds?: any[];
            components?: any[];
            files?: any[];
            ephemeral?: boolean;
        },
): Promise<any>
Parameters
- payload:
      | string
      | {
          content?: string;
          embeds?: any[];
          components?: any[];
          files?: any[];
          ephemeral?: boolean;
      }
Returns Promise<any>
Inherited from Pop.reply
- Defined in types.ts:177

defer

defer(options?: { ephemeral?: boolean }): Promise<void>
Parameters
- Optionaloptions: { ephemeral?: boolean }
Returns Promise<void>
Inherited from Pop.defer
- Defined in types.ts:178

respond

respond(choices: { name: string; value: string | number }[]): Promise<void>
Parameters
- choices: { name: string; value: string | number }[]
Returns Promise<void>
Inherited from Pop.respond
- Defined in types.ts:179

respondFiltered

respondFiltered(
choices: { name: string; value: string | number }[],
userInput: string,
): Promise<void>
Parameters
- choices: { name: string; value: string | number }[]
- userInput: string
Returns Promise<void>
Inherited from Pop.respondFiltered
- Defined in types.ts:180

Properties

ai

ai: {
    generate(prompt: string): Promise<string>;
    chat(
        history: { role: "user" | "system" | "assistant"; content: string }[],
    ): Promise<string>;
}

canvas

canvas: {
    create(width: number, height: number): Promise<CanvasBuilder>;
    nowPlayingCard(
        track: NowPlayingTrack,
        opts?: NowPlayingCardOptions,
    ): Promise<AttachmentBuilder>;
}

captcha

captcha: { sendVerificationPanel(channelId: string): Promise<void> }

desk

desk: {
sendPanel(channelId: string): Promise<void>;
closeTicket(): Promise<void>;
}

economy

economy: {
    currencyName: string;
    getProfile(
        userId: string,
    ): Promise<
        | { xp: number; level: number; balance: number; last_daily: number }
        | null,
    >;
    addXp(userId: string, amount: number): Promise<boolean>;
    addBalance(userId: string, amount: number): Promise<void>;
}

giveaways

giveaways: {
    start(
        channelId: string,
        prize: string,
        winners: number,
        durationMs: number,
    ): Promise<void>;
}

lastfm

lastfm: {
    getAccount(
        userId: string,
    ): Promise<{ username: string; sessionKey: string } | null>;
}

mongoose

mongoose: __module

db

db: Database

sponsorblock

sponsorblock: {
    isEnabled(): boolean;
    setEnabled(enabled: boolean): void;
    getCategories(): string[];
    setCategories(cats: string[]): void;
    forceSkip(): Promise<boolean>;
}

client

client: PopiiClient<TState>

locale

locale: string

log

log: PopLogger

cooler

cooler: {
    get<T = any>(key: string): Promise<T | null>;
    set(key: string, value: any, ttlMs?: number): Promise<void>;
    delete(key: string): Promise<void>;
}

state

state: TState

locals

locals: TLocals

guild

guild: Guild | null

channel

channel: TextBasedChannel | null

user

user: User

member

member: GuildMember | APIInteractionGuildMember | null

options

options: PopOptions

input

input: TInput

`Optional`snapMatches

snapMatches?: RegExpMatchArray | null

`Optional`snapData

snapData?: any

`Optional`targetMessage

targetMessage?: Message<boolean> | null

`Optional`targetUser

targetUser?: User | null

interaction

interaction:
| ModalSubmitInteraction<CacheType>
| MessageComponentInteraction<CacheType>

message

message: Message<boolean>

Interface ComponentPop<TState, TInput, TLocals>

Example: Reply with an embed

Example: Defer a slow command

Type Parameters

Hierarchy (View Summary)

Index

Methods

Properties

Methods

success

Parameters

Returns Promise<void>

error

Parameters

Returns Promise<void>

info

Parameters

Returns Promise<void>

paginate

Parameters

Returns Promise<void>

prompt

Parameters

Returns Promise<string | null>

form

Parameters

Returns Promise<Record<string, string> | null>

awaitMessage

Parameters

Returns Promise<any>

wizard

Parameters

Returns Promise<Record<string, string> | null>

joinVoice

Returns Promise<any>

playAudio

Parameters

Returns Promise<{ player: any; title: string; metadata?: any }>

leaveVoice

Returns Promise<void>

getQueue

Returns any[]

getNowPlaying

Returns | { title: string; artist: string; duration: string; thumbnail?: string; requestedBy?: string; elapsedMs: number; elapsed: string; progress: number; } | null

getNowPlayingCard

Parameters

Returns Promise<AttachmentBuilder | null>

createAttachment

Parameters

Returns any

fetchJSON

Type Parameters

Parameters

Returns Promise<T>

fetchText

Parameters

Returns Promise<string>

fetchBuffer

Parameters

Returns Promise<ArrayBuffer>

fetchForm

Type Parameters

Parameters

Returns Promise<T>

cache

Type Parameters

Parameters

Returns Promise<T>

translate

Parameters

Returns string

t

Parameters

Returns string

pack

Parameters

Returns string

schedule

Parameters

Returns Promise<void>

Returns
| {
title: string;
artist: string;
duration: string;
thumbnail?: string;
requestedBy?: string;
elapsedMs: number;
elapsed: string;
progress: number;
}
| null

`Optional`snapMatches

`Optional`snapData

`Optional`targetMessage

`Optional`targetUser