PopiiClient

Popii

---

Popii / PopiiClient

Interface: PopiiClient<TState>

Defined in: types.ts:339

Type Parameters

TState

TState = any

Methods

start()

start(): Promise<void>

Defined in: types.ts:385

Returns

Promise<void>

---

stop()

stop(): Promise<void>

Defined in: types.ts:386

Returns

Promise<void>

---

reload()

reload(): Promise<void>

Defined in: types.ts:387

Returns

Promise<void>

---

schedule()

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

Defined in: types.ts:388

Parameters

taskName

string

payload?

any

delayMs?

number

Returns

Promise<void>

---

broadcast()

broadcast(event, data): Promise<void>

Defined in: types.ts:389

Parameters

event

string

data

any

Returns

Promise<void>

---

offBroadcast()

offBroadcast(event, listener): void

Defined in: types.ts:390

Parameters

event

string

listener

(data) => void

Returns

void

---

onBroadcast()

onBroadcast(event, listener): void

Defined in: types.ts:391

Parameters

event

string

listener

(data) => void

Returns

void

---

saveState()

saveState(): Promise<void>

Defined in: types.ts:392

Returns

Promise<void>

---

isPremium()

isPremium(userId, guildId?): Promise<boolean>

Defined in: types.ts:393

Parameters

userId

string

guildId?

string | null

Returns

Promise<boolean>

---

invalidate()

invalidate(key): Promise<void>

Defined in: types.ts:394

Parameters

key

string

Returns

Promise<void>

---

extend()

extend(name, factory): void

Defined in: types.ts:395

Parameters

name

string

factory

(pop) => any

Returns

void

---

setPresence()

setPresence(status): Promise<void>

Defined in: types.ts:396

Parameters

status

string

Returns

Promise<void>

---

getGuildConfig()?

optional getGuildConfig(guildId): Promise<Record<string, any>>

Defined in: types.ts:397

Parameters

guildId

string

Returns

Promise<Record<string, any>>

---

setGuildConfig()?

optional setGuildConfig(guildId, config): Promise<void>

Defined in: types.ts:398

Parameters

guildId

string

config

Record<string, any>

Returns

Promise<void>

Properties

mongoose

mongoose: __module

Defined in: plugins/mongoose.ts:16

---

config

config: PopiiClientConfig<TState>

Defined in: types.ts:340

---

commands

commands: Map<string, PopiiCommandDefinition<TState, any, PopiiLocals & Record<string, any>>>

Defined in: types.ts:341

---

snaps

snaps: Map<string | RegExp, PopiiComponentDefinition<TState, any, PopiiLocals & Record<string, any>>>

Defined in: types.ts:342

---

activeEvents

activeEvents: Map<string, (…args) => void>

Defined in: types.ts:343

---

locales

locales: Map<string, Record<string, string>>

Defined in: types.ts:344

---

middlewares

middlewares: PopiiMiddleware<TState, any, PopiiLocals & Record<string, any>>[]

Defined in: types.ts:345

---

tasks

tasks: Map<string, PopiiTaskDefinition<TState, unknown>>

Defined in: types.ts:346

---

activeTasks

activeTasks: any[]

Defined in: types.ts:347

---

redis?

optional redis?: PopiiRedisClient

Defined in: types.ts:348

---

redisSub?

optional redisSub?: PopiiRedisClient

Defined in: types.ts:349

---

storage?

optional storage?: PopiiStorageAdapter

Defined in: types.ts:350

---

_cooldowns

_cooldowns: Map<string, { expires: number; usages: number; lastUpdate: number; }>

Defined in: types.ts:351

---

_quotas

_quotas: Map<string, { expires: number; usages: number; }>

Defined in: types.ts:352

---

_mutexes

_mutexes: Map<string, boolean>

Defined in: types.ts:353

---

_cacheStore

_cacheStore: Map<string, { expires: number; value: any; }>

Defined in: types.ts:354

---

_cacheLocks?

optional _cacheLocks?: Map<string, Promise<any>>

Defined in: types.ts:355

---

_extensions?

optional _extensions?: Map<string, (pop) => any>

Defined in: types.ts:356

---

_cleanupInterval?

optional _cleanupInterval?: any

Defined in: types.ts:357

---

_logRotationInterval?

optional _logRotationInterval?: any

Defined in: types.ts:358

---

_delayedJobInterval?

optional _delayedJobInterval?: any

Defined in: types.ts:359

---

_sseBroadcastInterval?

optional _sseBroadcastInterval?: any

Defined in: types.ts:360

---

_webRateLimitInterval?

optional _webRateLimitInterval?: any

Defined in: types.ts:361

---

_paginationInterval?

optional _paginationInterval?: any

Defined in: types.ts:362

---

_paginationSessions?

optional _paginationSessions?: Map<string, { embeds: any[]; timeoutMs: number; expires: number; }>

Defined in: types.ts:363

---

_activeCollectors?

optional _activeCollectors?: Map<string, any>

Defined in: types.ts:364

---

_commandAnalytics?

optional _commandAnalytics?: Map<string, number>

Defined in: types.ts:365

---

_broadcastListeners?

optional _broadcastListeners?: Map<string, (data) => void[]>

Defined in: types.ts:366

---

_sseStreams?

optional _sseStreams?: Map<string, any>

Defined in: types.ts:367

---

isShuttingDown

isShuttingDown: boolean

Defined in: types.ts:368

---

activeExecutions

activeExecutions: number

Defined in: types.ts:369

---

_pendingTimeouts?

optional _pendingTimeouts?: Set<Timeout>

Defined in: types.ts:370

---

_executePlugins?

optional _executePlugins?: PopiiPlugin<any>[]

Defined in: types.ts:371

---

_errorPlugins?

optional _errorPlugins?: PopiiPlugin<any>[]

Defined in: types.ts:372

---

_disabledCommands

_disabledCommands: Set<string>

Defined in: types.ts:373

---

_auditLogs

_auditLogs: any[]

Defined in: types.ts:374

---

_terminalLogs?

optional _terminalLogs?: string[]

Defined in: types.ts:375

---

_rateLimitLogs?

optional _rateLimitLogs?: any[]

Defined in: types.ts:376

---

_blacklist

_blacklist: Set<string>

Defined in: types.ts:377

---

global

global: object

Defined in: types.ts:378

emit()

emit(event, data?): Promise<void>

Parameters

event

string

data?

any

Returns

Promise<void>

on()

on(event, listener): void

Parameters

event

string

listener

(data) => void

Returns

void

off()

off(event, listener): void

Parameters

event

string

listener

(data) => void

Returns

void

---

state

state: TState

Defined in: types.ts:383

---

discord

discord: Client

Defined in: types.ts:384