TaskPop

Popii / TaskPop

Interface: TaskPop<TState>

The execution context provided to task run functions.

Extends EventPop with a discord shorthand for pop.client.discord. guild and channel are null unless the task explicitly resolves them.

Extends

EventPop<TState>

Type Parameters

TState

TState = any

Methods

success()

success(message): Promise<void>

Defined in: plugins/ui.ts:43

Parameters

message

string

Returns

Promise<void>

Inherited from

EventPop.success

error()

error(message): Promise<void>

Defined in: plugins/ui.ts:44

Parameters

message

string

Returns

Promise<void>

Inherited from

EventPop.error

info()

info(message): Promise<void>

Defined in: plugins/ui.ts:45

Parameters

message

string

Returns

Promise<void>

Inherited from

EventPop.info

paginate()

paginate(source, timeoutMs?): Promise<void>

Defined in: plugins/ui.ts:46

Parameters

source

EmbedBuilder[] | { fetch: (page) => Promise<EmbedBuilder | null>; totalPages?: number; }

timeoutMs?

number

Returns

Promise<void>

Inherited from

EventPop.paginate

prompt()

prompt(embed, buttons, timeoutMs?): Promise<string | null>

Defined in: plugins/ui.ts:47

Parameters

embed

EmbedBuilder

buttons

string[]

timeoutMs?

number

Returns

Promise<string | null>

Inherited from

EventPop.prompt

confirm()

confirm(question, timeoutMs?): Promise<boolean>

Defined in: plugins/ui.ts:48

Parameters

question

string

timeoutMs?

number

Returns

Promise<boolean>

Inherited from

EventPop.confirm

form()

form(title, fields, timeoutMs?): Promise<Record<string, string> | null>

Defined in: plugins/ui.ts:49

Parameters

title

string

fields

FormField[]

timeoutMs?

number

Returns

Promise<Record<string, string> | null>

Inherited from

EventPop.form

awaitMessage()

awaitMessage(timeoutMs?, promptMessageId?): Promise<any>

Defined in: plugins/ui.ts:50

Parameters

timeoutMs?

number

promptMessageId?

string

Returns

Promise<any>

Inherited from

EventPop.awaitMessage

wizard()

wizard(steps, timeoutMs?): Promise<Record<string, string> | null>

Defined in: plugins/ui.ts:51

Parameters

steps

WizardStep[]

timeoutMs?

number

Returns

Promise<Record<string, string> | null>

Inherited from

EventPop.wizard

joinVoice()

joinVoice(): Promise<any>

Defined in: plugins/voice.ts:27

Returns

Promise<any>

Inherited from

EventPop.joinVoice

playAudio()

playAudio(urlOrStream): Promise<{ player: any; title: string; metadata?: any; }>

Defined in: plugins/voice.ts:28

Parameters

urlOrStream

any

Returns

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

Inherited from

EventPop.playAudio

leaveVoice()

leaveVoice(): Promise<void>

Defined in: plugins/voice.ts:29

Returns

Promise<void>

Inherited from

EventPop.leaveVoice

getQueue()

getQueue(): any[]

Defined in: plugins/voice.ts:30

Returns

any[]

Inherited from

EventPop.getQueue

getNowPlaying()

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

Defined in: plugins/voice.ts:31

Returns

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

Inherited from

EventPop.getNowPlaying

getNowPlayingCard()

getNowPlayingCard(opts?): Promise<AttachmentBuilder | null>

Defined in: plugins/voice.ts:32

Parameters

opts?

accentColor?

string

Returns

Promise<AttachmentBuilder | null>

Inherited from

EventPop.getNowPlayingCard

createAttachment()

createAttachment(path, name?): any

Defined in: types.ts:142

Parameters

path

string

name?

string

Returns

any

Inherited from

EventPop.createAttachment

fetchJSON()

fetchJSON<T>(url, init?): Promise<T>

Defined in: types.ts:143

Type Parameters

T

T = unknown

Parameters

url

string | URL | Request

init?

RequestInit

Returns

Promise<T>

Inherited from

EventPop.fetchJSON

fetchText()

fetchText(url, init?): Promise<string>

Defined in: types.ts:144

Parameters

url

string | URL | Request

init?

RequestInit

Returns

Promise<string>

Inherited from

EventPop.fetchText

fetchBuffer()

fetchBuffer(url, init?): Promise<ArrayBuffer>

Defined in: types.ts:145

Parameters

url

string | URL | Request

init?

RequestInit

Returns

Promise<ArrayBuffer>

Inherited from

EventPop.fetchBuffer

fetchForm()

fetchForm<T>(url, data, init?): Promise<T>

Defined in: types.ts:146

Type Parameters

T

T = unknown

Parameters

url

string | URL | Request

data

FormData

init?

RequestInit

Returns

Promise<T>

Inherited from

EventPop.fetchForm

cache()

cache<T>(key, ttlMs, fetcher): Promise<T>

Defined in: types.ts:147

Type Parameters

T

T

Parameters

key

string

ttlMs

number

fetcher

() => T | Promise<T>

Returns

Promise<T>

Inherited from

EventPop.cache

translate()

translate(key, args?): string

Defined in: types.ts:148

Parameters

key

string

args?

Record<string, any>

Returns

string

Inherited from

EventPop.translate

t()

t(key, args?): string

Defined in: types.ts:149

Parameters

key

string

args?

Record<string, any>

Returns

string

Inherited from

EventPop.t

pack()

pack(customId, data): string

Defined in: types.ts:155

Parameters

customId

string

data

any

Returns

string

Inherited from

EventPop.pack

schedule()

schedule(taskName, payload?, delayMs?): Promise<void>

Defined in: types.ts:160

Parameters

taskName

string

payload?

any

delayMs?

number

Returns

Promise<void>

Inherited from

EventPop.schedule

Properties

ai

ai: object

Defined in: plugins/ai.ts:16

generate()

generate(prompt): Promise<string>

Parameters

prompt

string

Returns

Promise<string>

chat()

chat(history): Promise<string>

Parameters

history

object[]

Returns

Promise<string>

Inherited from

EventPop.ai

economy

economy: object

Defined in: plugins/economy.ts:23

currencyName

currencyName: string

getProfile()

getProfile(guildId, userId): Promise<{ balance: number; last_daily: number; } | null>

Parameters

guildId

string

userId

string

Returns

Promise<{ balance: number; last_daily: number; } | null>

addBalance()

addBalance(guildId, userId, amount): Promise<void>

Parameters

guildId

string

userId

string

amount

number

Returns

Promise<void>

Inherited from

EventPop.economy

giveaways

giveaways: object

Defined in: plugins/giveaway.ts:18

start()

start(channelId, prize, winners, durationMs): Promise<void>

Parameters

channelId

string

prize

string

winners

number

durationMs

number

Returns

Promise<void>

Inherited from

EventPop.giveaways

levels

levels: object

Defined in: plugins/levels.ts:23

getProfile()

getProfile(guildId, userId): Promise<{ xp: number; level: number; } | null>

Parameters

guildId

string

userId

string

Returns

Promise<{ xp: number; level: number; } | null>

addXp()

addXp(guildId, userId, amount): Promise<{ leveledUp: boolean; newLevel: number; }>

Parameters

guildId

string

userId

string

amount

number

Returns

Promise<{ leveledUp: boolean; newLevel: number; }>

Inherited from

EventPop.levels

mongoose

mongoose: __module

Defined in: plugins/mongoose.ts:13

Inherited from

EventPop.mongoose

db

db: Database

Defined in: plugins/sqlite.ts:11

Inherited from

EventPop.db

session

session: object

Defined in: plugins/ui.ts:52

get()

get(key): Promise<any>

Parameters

key

string

Returns

Promise<any>

set()

set(key, value, ttlMs?): Promise<void>

Parameters

key

string

value

any

ttlMs?

number

Returns

Promise<void>

del()

del(key): Promise<void>

Parameters

key

string

Returns

Promise<void>

clear()

clear(): Promise<void>

Returns

Promise<void>

Inherited from

EventPop.session

sponsorblock

sponsorblock: object

Defined in: plugins/voice.ts:33

isEnabled()

isEnabled(): boolean

Returns

boolean

setEnabled()

setEnabled(enabled): void

Parameters

enabled

boolean

Returns

void

getCategories()

getCategories(): string[]

Returns

string[]

setCategories()

setCategories(cats): void

Parameters

cats

string[]

Returns

void

forceSkip()

forceSkip(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

EventPop.sponsorblock

execution?

readonly optional execution?: object

Defined in: types.ts:137

Correlation and cancellation metadata for this execution.

id

id: string

type

type: "command" | "event" | "component" | "task"

definitionId

definitionId: string

startedAt

startedAt: number

Inherited from

EventPop.execution

signal?

readonly optional signal?: AbortSignal

Defined in: types.ts:138

Inherited from

EventPop.signal

client

client: PopiiClient<TState>

Defined in: types.ts:139

Inherited from

EventPop.client

locale

locale: string

Defined in: types.ts:140

Inherited from

EventPop.locale

log

log: PopLogger

Defined in: types.ts:141

Inherited from

EventPop.log

cooler

cooler: object

Defined in: types.ts:150

get()

get<T>(key): Promise<T | null>

Type Parameters

T

T = any

Parameters

key

string

Returns

Promise<T | null>

set()

set(key, value, ttlMs?): Promise<void>

Parameters

key

string

value

any

ttlMs?

number

Returns

Promise<void>

delete()

delete(key): Promise<void>

Parameters

key

string

Returns

Promise<void>

Inherited from

EventPop.cooler

state

state: TState

Defined in: types.ts:156

Inherited from

EventPop.state

locals

locals: PopiiLocals & Record<string, any>

Defined in: types.ts:157

Inherited from

EventPop.locals

guild

guild: Guild | null

Defined in: types.ts:158

Inherited from

EventPop.guild

channel

channel: TextBasedChannel | null

Defined in: types.ts:159

Inherited from

EventPop.channel

discord

discord: Client<boolean>

Defined in: types.ts:173

Shorthand for pop.client.discord.