Interface CommentSupplierConfigure

CommentSupplier を新規作成する際の各種設定を保持します.

interface CommentSupplierConfigure {
    addComment(comment: string, ...conditions: ((ctx: CommentContext) => boolean)[]): CommentSupplierConfigure;
    comments(): CommentSchema[];
    comments(comments: CommentSchema[]): CommentSupplierConfigure;
    interval(): number;
    interval(interval: number): CommentSupplierConfigure;
    vars(): unknown;
    vars(vars: unknown): CommentSupplierConfigure;
}

Index

Methods

addComment comments interval vars

Methods

addComment

addComment(comment, ...conditions): CommentSupplierConfigure
出力するコメントを追加します.
Parameters
- comment: string
  コメント本文
- Rest...conditions: ((ctx: CommentContext) => boolean)[]
  コメントを出力する条件(複数指定可). 省略した場合、状況にかかわらず出力します.
Returns CommentSupplierConfigure
- Defined in builder/commentSupplierConfigure.ts:27

comments

comments(): CommentSchema[]
登録されたコメント設定を取得します

Returns CommentSchema[]
- Defined in builder/commentSupplierConfigure.ts:32
comments(comments): CommentSupplierConfigure
出力するコメントを設定します.

これまで設定した情報は削除されます.
Parameters
- comments: CommentSchema[]
  コメント情報
Returns CommentSupplierConfigure
- Defined in builder/commentSupplierConfigure.ts:41

interval

interval(): number
作成する CommentSupplier に設定するコメント生成間隔(ミリ秒)を取得します.

Returns number
- Defined in builder/commentSupplierConfigure.ts:12
interval(interval): CommentSupplierConfigure
作成する CommentSupplier に設定するコメント生成間隔(ミリ秒)を設定します.
Parameters
- interval: number
  コメントの生成間隔(ミリ秒)
Returns CommentSupplierConfigure
- Defined in builder/commentSupplierConfigure.ts:19

vars

vars(): unknown
作成する CommentSupplier のライブラリ利用者が自由に使えるフィールドを取得します.

Returns unknown
- Defined in builder/commentSupplierConfigure.ts:46
vars(vars): CommentSupplierConfigure
作成する CommentSupplier のライブラリ利用者が自由に使えるフィールドを設定します.
Parameters
- vars: unknown
  ライブラリ利用者が自由に使えるフィールド
Returns CommentSupplierConfigure
- Defined in builder/commentSupplierConfigure.ts:53