PopiiCommandDefinition

Popii

---

Popii / PopiiCommandDefinition

Interface: PopiiCommandDefinition<TState, TInput, TLocals>

Defined in: types.ts:265

The full definition of a Popii command, including its metadata, options, guards, and handler.

You don’t usually interact with this interface directly — use the command builder function, which infers all types for you.

Type Parameters

TState

TState = any

TInput

TInput = any

TLocals

TLocals = PopiiLocals & Record<string, any>

Methods

autocomplete()?

optional autocomplete(pop): void | Promise<void>

Defined in: types.ts:291

Parameters

pop

Pop<TState, TInput, TLocals>

Returns

void | Promise<void>

---

do()

do(pop): void | Promise<void>

Defined in: types.ts:307

Parameters

pop

Pop<TState, TInput, TLocals>

Returns

void | Promise<void>

Properties

name

name: string

Defined in: types.ts:266

---

nameLocalizations?

optional nameLocalizations?: Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", string>>

Defined in: types.ts:267

---

description

description: string

Defined in: types.ts:268

---

descriptionLocalizations?

optional descriptionLocalizations?: Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", string>>

Defined in: types.ts:269

---

type?

optional type?: ApplicationCommandType

Defined in: types.ts:270

---

slash?

optional slash?: boolean

Defined in: types.ts:271

---

text?

optional text?: boolean

Defined in: types.ts:272

---

category?

optional category?: string

Defined in: types.ts:273

---

aliases?

optional aliases?: string[]

Defined in: types.ts:274

---

usage?

optional usage?: string

Defined in: types.ts:275

---

integrationTypes?

optional integrationTypes?: ApplicationIntegrationType[]

Defined in: types.ts:276

---

contexts?

optional contexts?: InteractionContextType[]

Defined in: types.ts:277

---

quota?

optional quota?: object

Defined in: types.ts:278

limit

limit: number

timeframe

timeframe: number

scope?

optional scope?: "user" | "guild" | "global"

---

cooldown?

optional cooldown?: number | { ms: number; uses?: number; scope?: "user" | "guild" | "global"; }

Defined in: types.ts:279

---

guildOnly?

optional guildOnly?: boolean

Defined in: types.ts:280

---

ownerOnly?

optional ownerOnly?: boolean

Defined in: types.ts:281

---

premium?

optional premium?: boolean

Defined in: types.ts:282

---

ephemeral?

optional ephemeral?: boolean

Defined in: types.ts:283

---

mutex?

optional mutex?: boolean

Defined in: types.ts:284

---

hidden?

optional hidden?: boolean

Defined in: types.ts:285

---

permissions?

optional permissions?: (bigint | "CreateInstantInvite" | "KickMembers" | "BanMembers" | "Administrator" | "ManageChannels" | "ManageGuild" | "AddReactions" | "ViewAuditLog" | "PrioritySpeaker" | "Stream" | "ViewChannel" | "SendMessages" | "SendTTSMessages" | "ManageMessages" | "EmbedLinks" | "AttachFiles" | "ReadMessageHistory" | "MentionEveryone" | "UseExternalEmojis" | "ViewGuildInsights" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "UseVAD" | "ChangeNickname" | "ManageNicknames" | "ManageRoles" | "ManageWebhooks" | "ManageEmojisAndStickers" | "ManageGuildExpressions" | "UseApplicationCommands" | "RequestToSpeak" | "ManageEvents" | "ManageThreads" | "CreatePublicThreads" | "CreatePrivateThreads" | "UseExternalStickers" | "SendMessagesInThreads" | "UseEmbeddedActivities" | "ModerateMembers" | "ViewCreatorMonetizationAnalytics" | "UseSoundboard" | "CreateGuildExpressions" | "CreateEvents" | "UseExternalSounds" | "SendVoiceMessages" | "SetVoiceChannelStatus" | "SendPolls" | "UseExternalApps" | "PinMessages" | "BypassSlowmode")[]

Defined in: types.ts:286

---

allowedRoles?

optional allowedRoles?: string[]

Defined in: types.ts:287

---

deniedRoles?

optional deniedRoles?: string[]

Defined in: types.ts:288

---

allowedChannels?

optional allowedChannels?: string[]

Defined in: types.ts:289

---

options?

optional options?: PopiiOption<TState, any, TLocals>[]

Defined in: types.ts:290

---

autocompleteCache?

optional autocompleteCache?: object

Defined in: types.ts:299

Cache autocomplete results to avoid re-running the handler on every keystroke. Results are keyed by (command, focused field, focused value, scope) and expire after ttlMs.

• "user" — separate cache per Discord user
• "guild" — separate cache per guild
• "global" — one shared cache for all users (default)

ttlMs

ttlMs: number

scope?

optional scope?: "user" | "guild" | "global"

---

autocompleteTimeoutMs?

optional autocompleteTimeoutMs?: number

Defined in: types.ts:300

---

middlewares?

optional middlewares?: PopiiMiddleware<TState, TInput, TLocals>[]

Defined in: types.ts:301

---

schema?

optional schema?: PopiiSchema<TInput>

Defined in: types.ts:302

---

deferAfter?

optional deferAfter?: number

Defined in: types.ts:304

Override the auto-defer threshold in ms. Defaults to 2000.

---

timeoutMs?

optional timeoutMs?: number

Defined in: types.ts:306

Maximum handler duration before cancellation. Defaults to the configured command timeout.