Popii - v0.5.1
    Preparing search index...

    Interface PopiiClient<TState>

    interface PopiiClient<TState = any> {
        mongoose: __module;
        config: PopiiClientConfig<TState>;
        commands: Map<
            string,
            PopiiCommandDefinition<TState, any, PopiiLocals & Record<string, any>>,
        >;
        snaps: Map<
            string
            | RegExp,
            PopiiComponentDefinition<TState, any, PopiiLocals & Record<string, any>>,
        >;
        activeEvents: Map<string, (...args: any[]) => void>;
        locales: Map<string, Record<string, string>>;
        middlewares: PopiiMiddleware<
            TState,
            any,
            PopiiLocals & Record<string, any>,
        >[];
        tasks: Map<string, PopiiTaskDefinition<TState>>;
        activeTasks: any[];
        redis?: PopiiRedisClient;
        redisSub?: PopiiRedisClient;
        storage?: PopiiStorageAdapter;
        _cooldowns: Map<
            string,
            { expires: number; usages: number; lastUpdate: number },
        >;
        _quotas: Map<string, { expires: number; usages: number }>;
        _mutexes: Map<string, boolean>;
        _cacheStore: Map<string, { expires: number; value: any }>;
        _cacheLocks?: Map<string, Promise<any>>;
        _extensions?: Map<string, (pop: EventPop) => any>;
        _cleanupInterval?: any;
        _logRotationInterval?: any;
        _delayedJobInterval?: any;
        _sseBroadcastInterval?: any;
        _webRateLimitInterval?: any;
        _paginationInterval?: any;
        _paginationSessions?: Map<
            string,
            { embeds: any[]; timeoutMs: number; expires: number },
        >;
        _activeCollectors?: Map<string, any>;
        _commandAnalytics?: Map<string, number>;
        _broadcastListeners?: Map<string, ((data: any) => void)[]>;
        _sseStreams?: Map<string, any>;
        isShuttingDown: boolean;
        activeExecutions: number;
        _pendingTimeouts?: Set<Timeout>;
        _executePlugins?: PopiiPlugin<any>[];
        _errorPlugins?: PopiiPlugin<any>[];
        _disabledCommands: Set<string>;
        _auditLogs: any[];
        _terminalLogs?: string[];
        _rateLimitLogs?: any[];
        _blacklist: Set<string>;
        global: {
            emit(event: string, data?: any): Promise<void>;
            on(event: string, listener: (data: any) => void): void;
            off(event: string, listener: (data: any) => void): void;
        };
        state: TState;
        discord: Client;
        start(): Promise<void>;
        stop(): Promise<void>;
        reload(): Promise<void>;
        schedule(taskName: string, payload?: any, delayMs?: number): Promise<void>;
        broadcast(event: string, data: any): Promise<void>;
        offBroadcast(event: string, listener: (data: any) => void): void;
        onBroadcast(event: string, listener: (data: any) => void): void;
        saveState(): Promise<void>;
        isPremium(userId: string, guildId?: string | null): Promise<boolean>;
        reloadPlugin(name: string): Promise<boolean>;
        invalidate(key: string): Promise<void>;
        extend(name: string, factory: (pop: EventPop) => any): void;
        setPresence(status: string): Promise<void>;
        getGuildConfig?(guildId: string): Promise<Record<string, any>>;
        getGuildConfig?(guildId: string): Promise<any>;
        setGuildConfig?(
            guildId: string,
            config: Record<string, any>,
        ): Promise<void>;
        setGuildConfig?(guildId: string, config: any): Promise<void>;
    }

    Type Parameters

    • TState = any
    Index

    Methods

    start stop reload schedule broadcast offBroadcast onBroadcast saveState isPremium reloadPlugin invalidate extend setPresence getGuildConfig? setGuildConfig?

    Properties

    mongoose config commands snaps activeEvents locales middlewares tasks activeTasks redis? redisSub? storage? _cooldowns _quotas _mutexes _cacheStore _cacheLocks? _extensions? _cleanupInterval? _logRotationInterval? _delayedJobInterval? _sseBroadcastInterval? _webRateLimitInterval? _paginationInterval? _paginationSessions? _activeCollectors? _commandAnalytics? _broadcastListeners? _sseStreams? isShuttingDown activeExecutions _pendingTimeouts? _executePlugins? _errorPlugins? _disabledCommands _auditLogs _terminalLogs? _rateLimitLogs? _blacklist global state discord

    Methods

    • Returns Promise<void>

    • Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • taskName: string
      • Optionalpayload: any
      • OptionaldelayMs: number

      Returns Promise<void>

    • Parameters

      • event: string
      • data: any

      Returns Promise<void>

    • Parameters

      • event: string
      • listener: (data: any) => void

      Returns void

    • Parameters

      • event: string
      • listener: (data: any) => void

      Returns void

    • Returns Promise<void>

    • Parameters

      • userId: string
      • OptionalguildId: string | null

      Returns Promise<boolean>

    • Parameters

      • name: string

      Returns Promise<boolean>

    • Parameters

      • key: string

      Returns Promise<void>

    • Parameters

      • name: string
      • factory: (pop: EventPop) => any

      Returns void

    • Parameters

      • status: string

      Returns Promise<void>

    • Parameters

      • guildId: string

      Returns Promise<Record<string, any>>

    • Parameters

      • guildId: string

      Returns Promise<any>

    • Parameters

      • guildId: string
      • config: Record<string, any>

      Returns Promise<void>

    • Parameters

      • guildId: string
      • config: any

      Returns Promise<void>

    Properties

    mongoose: __module
    config: PopiiClientConfig<TState>
    commands: Map<
        string,
        PopiiCommandDefinition<TState, any, PopiiLocals & Record<string, any>>,
    >
    snaps: Map<
        string
        | RegExp,
        PopiiComponentDefinition<TState, any, PopiiLocals & Record<string, any>>,
    >
    activeEvents: Map<string, (...args: any[]) => void>
    locales: Map<string, Record<string, string>>
    middlewares: PopiiMiddleware<TState, any, PopiiLocals & Record<string, any>>[]
    tasks: Map<string, PopiiTaskDefinition<TState>>
    activeTasks: any[]
    redis?: PopiiRedisClient
    redisSub?: PopiiRedisClient
    storage?: PopiiStorageAdapter

    _cooldowns

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

    _quotas

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

    _mutexes

    _mutexes: Map<string, boolean>

    _cacheStore

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

    Optional_cacheLocks

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

    Optional_extensions

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

    Optional_cleanupInterval

    _cleanupInterval?: any

    Optional_logRotationInterval

    _logRotationInterval?: any

    Optional_delayedJobInterval

    _delayedJobInterval?: any

    Optional_sseBroadcastInterval

    _sseBroadcastInterval?: any

    Optional_webRateLimitInterval

    _webRateLimitInterval?: any

    Optional_paginationInterval

    _paginationInterval?: any

    Optional_paginationSessions

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

    Optional_activeCollectors

    _activeCollectors?: Map<string, any>

    Optional_commandAnalytics

    _commandAnalytics?: Map<string, number>

    Optional_broadcastListeners

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

    Optional_sseStreams

    _sseStreams?: Map<string, any>
    isShuttingDown: boolean
    activeExecutions: number

    Optional_pendingTimeouts

    _pendingTimeouts?: Set<Timeout>

    Optional_executePlugins

    _executePlugins?: PopiiPlugin<any>[]

    Optional_errorPlugins

    _errorPlugins?: PopiiPlugin<any>[]

    _disabledCommands

    _disabledCommands: Set<string>

    _auditLogs

    _auditLogs: any[]

    Optional_terminalLogs

    _terminalLogs?: string[]

    Optional_rateLimitLogs

    _rateLimitLogs?: any[]

    _blacklist

    _blacklist: Set<string>
    global: {
        emit(event: string, data?: any): Promise<void>;
        on(event: string, listener: (data: any) => void): void;
        off(event: string, listener: (data: any) => void): void;
    }
    state: TState
    discord: Client

    Settings

    Member Visibility

    On This Page

    Methods
    Properties