Skip to content
popii

PopiiOption

Popii

Popii / PopiiOption

Interface: PopiiOption<TState, TInput, TLocals>

Section titled “Interface: PopiiOption<TState, TInput, TLocals>”

Defined in: types.ts:42

Type Parameters

Section titled “Type Parameters”

TState

Section titled “TState”

TState = any

TInput

Section titled “TInput”

TInput = any

TLocals

Section titled “TLocals”

TLocals = Record<string, any>

Methods

Section titled “Methods”

do()?

Section titled “do()?”

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

Defined in: types.ts:54

Parameters

Section titled “Parameters”
pop
Section titled “pop”

Pop<TState, TInput, TLocals>

Returns

Section titled “Returns”

void | Promise<void>

Properties

Section titled “Properties”

name

Section titled “name”

name: string

Defined in: types.ts:43

nameLocalizations?

Section titled “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:44

description

Section titled “description”

description: string

Defined in: types.ts:45

descriptionLocalizations?

Section titled “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:46

type

Section titled “type”

type: ApplicationCommandOptionType

Defined in: types.ts:47

required?

Section titled “required?”

optional required?: boolean

Defined in: types.ts:48

autocomplete?

Section titled “autocomplete?”

optional autocomplete?: boolean | ((pop) => void | Promise<void | object[]> | object[])

Defined in: types.ts:49

choices?

Section titled “choices?”

optional choices?: object[]

Defined in: types.ts:50

name

Section titled “name”

name: string

value

Section titled “value”

value: string | number

options?

Section titled “options?”

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

Defined in: types.ts:51

minValue?

Section titled “minValue?”

optional minValue?: number

Defined in: types.ts:52

maxValue?

Section titled “maxValue?”

optional maxValue?: number

Defined in: types.ts:53

guildOnly?

Section titled “guildOnly?”

optional guildOnly?: boolean

Defined in: types.ts:55

ownerOnly?

Section titled “ownerOnly?”

optional ownerOnly?: boolean

Defined in: types.ts:56

permissions?

Section titled “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:57

allowedRoles?

Section titled “allowedRoles?”

optional allowedRoles?: string[]

Defined in: types.ts:58

deniedRoles?

Section titled “deniedRoles?”

optional deniedRoles?: string[]

Defined in: types.ts:59

allowedChannels?

Section titled “allowedChannels?”

optional allowedChannels?: string[]

Defined in: types.ts:60

cooldown?

Section titled “cooldown?”

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

Defined in: types.ts:61

quota?

Section titled “quota?”

optional quota?: object

Defined in: types.ts:62

limit

Section titled “limit”

limit: number

timeframe

Section titled “timeframe”

timeframe: number

scope?

Section titled “scope?”

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

ephemeral?

Section titled “ephemeral?”

optional ephemeral?: boolean

Defined in: types.ts:63

middlewares?

Section titled “middlewares?”

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

Defined in: types.ts:64

schema?

Section titled “schema?”

optional schema?: PopiiSchema<any>

Defined in: types.ts:65

autocompleteCache?

Section titled “autocompleteCache?”

optional autocompleteCache?: object

Defined in: types.ts:66

ttlMs

Section titled “ttlMs”

ttlMs: number

scope?

Section titled “scope?”

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

autocompleteTimeoutMs?

Section titled “autocompleteTimeoutMs?”

optional autocompleteTimeoutMs?: number

Defined in: types.ts:67