メインコンテンツまでスキップ
バージョン: v2 Next 🚧

インターフェイス: ClientConfig

定義: src/config.ts:16

設定ファイル1枚が返すもの。ClientOptions の部分指定に、 ローダーだけが読む priority を足したものです。

1枚に全部書く必要はありません。関心ごとにファイルを分け (config/intents.ts、config/music.ts、config/ai.ts ...)、 ローダーが1つの ClientOptions にまとめます。

拡張​

プロパティ​

applicationGuildIds?​

optional applicationGuildIds?: readonly string[];

定義: src/client.ts:77

スラッシュコマンドを登録する既定のギルド — 開発中に便利です (ギルドコマンドは即時反映)。コマンド側の guildIds が優先され、 どちらもなければグローバル登録になります。

継承元​

ClientOptions.applicationGuildIds


baseDirectory?​

optional baseDirectory?: string | URL | null;

定義: src/client.ts:32

コンポーネント自動探索のルートディレクトリ。各ストアが <baseDirectory>/<ストア名>(services/、commands/、listeners/、 preconditions/、...)を走査します。

既定はプロセスのエントリポイント(Bun.main)のあるディレクトリです。 null を渡すと自動探索を無効化し、明示登録のみになります。

継承元​

ClientOptions.baseDirectory


defaultPrefix?​

optional defaultPrefix?: string | readonly string[] | null;

定義: src/client.ts:53

メッセージ(プレフィックス)コマンドを有効にするプレフィックス。 省略(または null)でスラッシュコマンド専用の Bot になります。

継承元​

ClientOptions.defaultPrefix


fetchPrefix?​

optional fetchPrefix?: (message, container) => Awaitable<string | readonly string[] | null>;

定義: src/client.ts:61

メッセージ毎にプレフィックスを解決します(ギルド毎のプレフィックス等)。 defaultPrefix より優先され、null を返すとそのメッセージでは メッセージコマンドが無効になります。コンテナが渡されるため、 クライアント変数を参照せずにサービスへ到達できます。

パラメータ​

message​

Message

container​

Container

戻り値​

Awaitable<string | readonly string[] | null>

継承元​

ClientOptions.fetchPrefix


logger?​

optional logger?: Logger | LoggerOptions<never, boolean>;

定義: src/client.ts:38

フレームワークのロガー: 採用したい pino インスタンス、または pino に 渡すオプション。既定は pino({ level: "info" }) です。

継承元​

ClientOptions.logger


plugins?​

optional plugins?: readonly Plugin[];

定義: src/client.ts:41

プラグイン。Client.load の冒頭で配列順にインストールされます。

継承元​

ClientOptions.plugins


priority?​

optional priority?: number;

定義: src/config.ts:22

読み込み順。大きいほど先(= プラグインが先にインストールされる)。 同じ値ならファイル名順。

Default​

0

syncApplicationCommands?​

optional syncApplicationCommands?: boolean;

定義: src/client.ts:70

クライアントの ready 時にスラッシュコマンドを Discord へ一括登録する。

Default​

true

継承元​

ClientOptions.syncApplicationCommands


texts?​

optional texts?: Partial<ClientTexts>;

定義: src/client.ts:47

フレームワークがユーザーへ返す文言。指定した項目だけが既定値 (defaultClientTexts)を上書きします。

継承元​

ClientOptions.texts