seyfert
    Preparing search index...

    Interface ClientOptions

    interface ClientOptions {
        allowedMentions?: APIAllowedMentions;
        commands?: {
            defaults?: {
                onAfterRun?: (
                    context: CommandContext<{}, never> | MenuCommandContext<any, never>,
                    error: unknown,
                ) => unknown;
                onBeforeMiddlewares?: (
                    context: CommandContext<{}, never> | MenuCommandContext<any, never>,
                ) => unknown;
                onBeforeOptions?: (context: CommandContext) => any;
                onBotPermissionsFail?: (
                    context: CommandContext<{}, never> | MenuCommandContext<any, never>,
                    permissions: PermissionStrings,
                ) => unknown;
                onInternalError?: (
                    client: UsingClient,
                    command: Command | ContextMenuCommand | SubCommand,
                    error?: unknown,
                ) => unknown;
                onMiddlewaresError?: (
                    context: CommandContext<{}, never> | MenuCommandContext<any, never>,
                    error: string,
                ) => unknown;
                onOptionsError?: (
                    context: CommandContext,
                    metadata: OnOptionsReturnObject,
                ) => any;
                onPermissionsFail?: (
                    context: CommandContext,
                    permissions: PermissionStrings,
                ) => any;
                onRunError?: (
                    context: CommandContext<{}, never> | MenuCommandContext<any, never>,
                    error: unknown,
                ) => unknown;
                props?: ExtraProps;
            };
        } & {
            deferReplyResponse?: (
                ctx: CommandContext,
            ) => Awaitable<
                Omit<
                    RESTPostAPIChannelMessageJSONBody,
                    "components"
                    | "content"
                    | "embeds"
                    | "poll",
                > & SendResolverProps,
            >;
            prefix?: (message: Message) => Awaitable<string[]>;
            reply?: (ctx: CommandContext) => Awaitable<boolean>;
        };
        components?: {
            defaults?: {
                onAfterRun?: (context: ComponentContext, error: unknown) => any;
                onBeforeMiddlewares?: (context: ComponentContext) => any;
                onInternalError?: (client: UsingClient, error?: unknown) => any;
                onMiddlewaresError?: (context: ComponentContext, error: string) => any;
                onRunError?: (context: ComponentContext, error: unknown) => any;
            };
        };
        context?: (
            interaction:
                | ModalSubmitInteraction<boolean>
                | ChatInputCommandInteraction<boolean>
                | UserCommandInteraction<boolean>
                | MessageCommandInteraction<boolean>
                | EntryPointInteraction<boolean>
                | ComponentInteraction<boolean, APIMessageComponentInteraction>,
        ) => Record<string, unknown>;
        gateway?: {
            compress?: boolean;
            properties?: Partial<undefined | IdentifyProperties>;
        };
        globalMiddlewares?: readonly never[];
        handlePayload?: (
            shardId: number,
            packet: GatewayDispatchPayload,
        ) => unknown;
        modals?: {
            defaults?: {
                onAfterRun?: (context: ModalContext, error: unknown) => any;
                onBeforeMiddlewares?: (context: ModalContext) => any;
                onInternalError?: (client: UsingClient, error?: unknown) => any;
                onMiddlewaresError?: (context: ModalContext, error: string) => any;
                onRunError?: (context: ModalContext, error: unknown) => any;
            };
        };
        presence?: (shardId: number) => GatewayPresenceUpdateData;
        resharding?: PickPartial<
            {
                interval: number;
                percentage: number;
                getInfo(): Promise<APIGatewayBotInfo>;
            },
            "getInfo",
        >;
        shards?: { end: number; start: number; total?: number };
        getRC(): Awaitable<InternalRuntimeConfigHTTP | InternalRuntimeConfig>;
    }

    Hierarchy

    • BaseClientOptions
      • ClientOptions
    Index

    Properties

    allowedMentions?: APIAllowedMentions
    commands?: {
        defaults?: {
            onAfterRun?: (
                context: CommandContext<{}, never> | MenuCommandContext<any, never>,
                error: unknown,
            ) => unknown;
            onBeforeMiddlewares?: (
                context: CommandContext<{}, never> | MenuCommandContext<any, never>,
            ) => unknown;
            onBeforeOptions?: (context: CommandContext) => any;
            onBotPermissionsFail?: (
                context: CommandContext<{}, never> | MenuCommandContext<any, never>,
                permissions: PermissionStrings,
            ) => unknown;
            onInternalError?: (
                client: UsingClient,
                command: Command | ContextMenuCommand | SubCommand,
                error?: unknown,
            ) => unknown;
            onMiddlewaresError?: (
                context: CommandContext<{}, never> | MenuCommandContext<any, never>,
                error: string,
            ) => unknown;
            onOptionsError?: (
                context: CommandContext,
                metadata: OnOptionsReturnObject,
            ) => any;
            onPermissionsFail?: (
                context: CommandContext,
                permissions: PermissionStrings,
            ) => any;
            onRunError?: (
                context: CommandContext<{}, never> | MenuCommandContext<any, never>,
                error: unknown,
            ) => unknown;
            props?: ExtraProps;
        };
    } & {
        deferReplyResponse?: (
            ctx: CommandContext,
        ) => Awaitable<
            Omit<
                RESTPostAPIChannelMessageJSONBody,
                "components"
                | "content"
                | "embeds"
                | "poll",
            > & SendResolverProps,
        >;
        prefix?: (message: Message) => Awaitable<string[]>;
        reply?: (ctx: CommandContext) => Awaitable<boolean>;
    }
    components?: {
        defaults?: {
            onAfterRun?: (context: ComponentContext, error: unknown) => any;
            onBeforeMiddlewares?: (context: ComponentContext) => any;
            onInternalError?: (client: UsingClient, error?: unknown) => any;
            onMiddlewaresError?: (context: ComponentContext, error: string) => any;
            onRunError?: (context: ComponentContext, error: unknown) => any;
        };
    }
    context?: (
        interaction:
            | ModalSubmitInteraction<boolean>
            | ChatInputCommandInteraction<boolean>
            | UserCommandInteraction<boolean>
            | MessageCommandInteraction<boolean>
            | EntryPointInteraction<boolean>
            | ComponentInteraction<boolean, APIMessageComponentInteraction>,
    ) => Record<string, unknown>
    gateway?: {
        compress?: boolean;
        properties?: Partial<undefined | IdentifyProperties>;
    }
    globalMiddlewares?: readonly never[]
    handlePayload?: (shardId: number, packet: GatewayDispatchPayload) => unknown

    Type declaration

      • (shardId: number, packet: GatewayDispatchPayload): unknown
      • The payload handlers for messages on the shard.

        Parameters

        • shardId: number
        • packet: GatewayDispatchPayload

        Returns unknown

    modals?: {
        defaults?: {
            onAfterRun?: (context: ModalContext, error: unknown) => any;
            onBeforeMiddlewares?: (context: ModalContext) => any;
            onInternalError?: (client: UsingClient, error?: unknown) => any;
            onMiddlewaresError?: (context: ModalContext, error: string) => any;
            onRunError?: (context: ModalContext, error: unknown) => any;
        };
    }
    presence?: (shardId: number) => GatewayPresenceUpdateData
    resharding?: PickPartial<
        {
            interval: number;
            percentage: number;
            getInfo(): Promise<APIGatewayBotInfo>;
        },
        "getInfo",
    >
    shards?: { end: number; start: number; total?: number }

    Methods

    • Returns Awaitable<InternalRuntimeConfigHTTP | InternalRuntimeConfig>