跳到主要内容

TriggerContext

Defined in: packages/rxdb-plugin-trigger/src/types.ts:118

TriggerContext - 任务执行上下文

在任务 run 函数被调用时传入,包含执行所需的所有信息和控制接口。

Properties

attempt

attempt: number;

Defined in: packages/rxdb-plugin-trigger/src/types.ts:122

当前尝试次数(第几次执行)


logger

logger: Pick<Console, "log" | "warn" | "error">;

Defined in: packages/rxdb-plugin-trigger/src/types.ts:126

日志记录器


metadata?

optional metadata?: Record<string, unknown>;

Defined in: packages/rxdb-plugin-trigger/src/types.ts:128

业务元数据


runId

runId: string;

Defined in: packages/rxdb-plugin-trigger/src/types.ts:120

当前运行ID


signal

signal: AbortSignal;

Defined in: packages/rxdb-plugin-trigger/src/types.ts:124

中止信号,可调用 abort() 取消任务

Methods

progress()

progress(percent, message?): void;

Defined in: packages/rxdb-plugin-trigger/src/types.ts:130

上报进度,触发后 debounce 200ms 再实际保存

Parameters

ParameterType
percentnumber
message?string

Returns

void