跳到主要内容

TriggerOptions

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

TriggerOptions - 触发选项

每次触发任务时可传入的额外配置。

Properties

concurrencyKey?

optional concurrencyKey?: string;

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

并发控制键,同一键的任务不会并发执行


debounce?

optional debounce?: DebounceConfig;

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

防抖配置


delay?

optional delay?: string | number;

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

延迟执行时间。支持毫秒数或时间字符串(如 '5s', '2m')。

精度说明: 实际触发时间由 ScheduleClock 轮询驱动(默认 2 秒), 可能比 scheduledAt 晚最多一个轮询间隔。当 delaySafe 为 false 时, fallback 到 setTimeout。


idempotencyKey?

optional idempotencyKey?: string;

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

幂等性键,防止重复触发


idempotencyKeyTTL?

optional idempotencyKeyTTL?: string | number;

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

幂等键的 TTL,默认 7 天


maxAttempts?

optional maxAttempts?: number;

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

覆盖任务定义的最大尝试次数


metadata?

optional metadata?: Record<string, unknown>;

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

业务元数据


priority?

optional priority?: number;

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

优先级,数值越小优先级越高


tags?

optional tags?: string[];

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

标签数组


ttl?

optional ttl?: string | number;

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

过期时间,超过此时间未执行则标记为 EXPIRED


waitTimeout?

optional waitTimeout?: number;

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

triggerAndWait 超时时间(毫秒)