nyx Typedoc
    Preparing search index...

    Interface NyxBot<Implementations>

    A bot of the nyx framework, of any platform.

    If you need platform-specific APIs, use its respective type, like DjsNyxBot.

    interface NyxBot<
        Implementations extends
            InjectableBotDependencies<any, any, any, any> = InjectableBotDependencies<
            any,
            NyxClient,
            any,
            any,
        >,
    > {
        decorate<Key extends string | symbol, Value>(
            key: Key,
            value: Value,
        ): asserts this is NyxBot<Implementations> & Record<Key, Value>;
        getClient(): Implementations["client"];
        getClientEventBus(): Implementations["clientEventBus"];
        getCommandManager(): Implementations["commandManager"];
        getLogger(): Implementations["logger"];
        getPluginManager(): Implementations["pluginManager"];
        getScheduleManager(): Implementations["scheduleManager"];
        getService(): Implementations["service"];
        getStatus(): BotStatus;
        getToken(): string;
        start(): Promise<NyxBot<Implementations>>;
        stop(reason?: Identifier): Promise<NyxBot<Implementations>>;
        subscribeToClient(
            ...subscribers: Parameters<
                Implementations["clientEventBus"]["subscribe"],
            >,
        ): Promise<NyxBot<Implementations>>;
    }

    Type Parameters

    Implemented by

    Index