Skip to content

Client

Gateway client instance, including registered plugin extensions.

Signature

export type Client<TPluginsOrReady extends readonly AnySeyfertPlugin[] | boolean = RegisteredPlugins, Ready extends boolean = boolean> = ClientBase<ClientReadyOf<TPluginsOrReady, Ready>> & ClientAmbientExtensionOf<TPluginsOrReady> & Materialize<ExtendOf<ClientPluginsOf<TPluginsOrReady>>>;

Private types

ClientReadyOfTypeAlias
type ClientReadyOf<TPluginsOrReady extends readonly AnySeyfertPlugin[] | boolean, Ready extends boolean> = TPluginsOrReady extends boolean ? TPluginsOrReady : Ready;
ClientAmbientExtensionOfTypeAlias
type ClientAmbientExtensionOf<TPluginsOrReady extends readonly AnySeyfertPlugin[] | boolean> = TPluginsOrReady extends readonly AnySeyfertPlugin[] ? {} : RegisteredPluginExtension;
MaterializeTypeAlias
type Materialize<T> = {    [K in keyof T]: T[K];};
ClientPluginsOfTypeAlias
type ClientPluginsOf<TPluginsOrReady extends readonly AnySeyfertPlugin[] | boolean> = TPluginsOrReady extends readonly AnySeyfertPlugin[] ? TPluginsOrReady : RegisteredPlugins;

Properties

botIdSetter
set botId(id: string);
botIdGetter
get botId(): string;

Methods

close(): Promise<void>;

Closes resources managed by the plugin lifecycle. This waits for in-flight plugin setup and runs `SeyfertPlugin.teardown`. It does not close the gateway, REST client, or cache adapter.

uploadCommands({ applicationId, cachePath }?: {    applicationId?: string;    cachePath?: string;}): Promise<void>;