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

インターフェイス: UtilsOptions

定義: plugins/utils/src/index.ts:39

プロパティ​

scheduler?​

optional scheduler?: boolean;

定義: plugins/utils/src/index.ts:44

tasks/ の自動ロードと定期実行を有効にする。

Default​

true

theme?​

optional theme?: object;

定義: plugins/utils/src/index.ts:54

Bot 全体の見た目。指定した項目だけが既定値を上書きします。

colors?​

optional colors?: object;
colors.error?​
optional error?: number;
colors.info?​
optional info?: number;
colors.success?​
optional success?: number;
colors.warning?​
optional warning?: number;

confirm?​

optional confirm?: object;
confirm.no?​
optional no?: object;
confirm.no.emoji?​
optional emoji?: string;
confirm.no.label?​
optional label?: string;
confirm.no.style?​
optional style?: ButtonStyle;
confirm.timeout?​
optional timeout?: DurationInput;

応答を待つ時間。

confirm.yes?​
optional yes?: object;
confirm.yes.emoji?​
optional emoji?: string;
confirm.yes.label?​
optional label?: string;
confirm.yes.style?​
optional style?: ButtonStyle;

duration?​

optional duration?: object;
duration.clock?​
optional clock?: object;

formatDuration の時計表記(区切り・ゼロ埋め)。

duration.clock.alwaysHours?​
optional alwaysHours?: boolean;

1時間未満でも時を出す。

Default​

defaultTheme.duration.clock.alwaysHours(false)

duration.clock.pad?​
optional pad?: string;

分・秒を2桁に揃える文字。

Default​

defaultTheme.duration.clock.pad("0")

duration.clock.separator?​
optional separator?: string;

時・分・秒の区切り。

Default​

defaultTheme.duration.clock.separator(":")

duration.max?​
optional max?: number;

既定で出す単位の数。

duration.separator?​
optional separator?: string;

単位のあいだに挟む文字列。

duration.units?​
optional units?: object;

humanizeDuration が使う単位。日本語にするならここ。

duration.units.d?​
optional d?: string;
duration.units.h?​
optional h?: string;
duration.units.m?​
optional m?: string;
duration.units.ms?​
optional ms?: string;
duration.units.s?​
optional s?: string;

pagination?​

optional pagination?: object;
pagination.counter?​
optional counter?: (current, total) => string;

中央に出す現在位置の文字列。

パラメータ​
current​

number

total​

number

戻り値​

string

pagination.counterStyle?​
optional counterStyle?: ButtonStyle;
pagination.first?​
optional first?: object;
pagination.first.emoji?​
optional emoji?: string;
pagination.first.label?​
optional label?: string;
pagination.first.style?​
optional style?: ButtonStyle;
pagination.last?​
optional last?: object;
pagination.last.emoji?​
optional emoji?: string;
pagination.last.label?​
optional label?: string;
pagination.last.style?​
optional style?: ButtonStyle;
pagination.next?​
optional next?: object;
pagination.next.emoji?​
optional emoji?: string;
pagination.next.label?​
optional label?: string;
pagination.next.style?​
optional style?: ButtonStyle;
pagination.prev?​
optional prev?: object;
pagination.prev.emoji?​
optional emoji?: string;
pagination.prev.label?​
optional label?: string;
pagination.prev.style?​
optional style?: ButtonStyle;
pagination.showCounter?​
optional showCounter?: boolean;

現在位置のボタンを出すか。

pagination.timeout?​
optional timeout?: DurationInput;

無操作でボタンを無効化するまでの時間。

progress?​

optional progress?: object;
progress.empty?​
optional empty?: string;
progress.filled?​
optional filled?: string;
progress.width?​
optional width?: number;

text?​

optional text?: object;
text.ellipsis?​
optional ellipsis?: string;

truncate が末尾に付ける文字列。

Default​

defaultTheme


ui?​

optional ui?: boolean;

定義: plugins/utils/src/index.ts:49

this.services.ui を登録する。

Default​

true