ScheduleTaskDefinition<TOutput>

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

ScheduleTaskDefinition - 定时任务定义

定时任务与普通任务的区别在于: run 函数的入参是 SchedulePayload， 包含触发时间、时区、即将到来的触发时间等信息。

Type Parameters

Type Parameter	Default type
TOutput	unknown

Properties

catchUpPolicy?

optional catchUpPolicy?: CatchUpPolicy;

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

补发策略

---

cron

cron: string;

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

Cron 表达式

---

deduplicationKey?

optional deduplicationKey?: string;

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

去重键

---

executor?

optional executor?: "main" | "worker";

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

---

externalId?

optional externalId?: string;

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

外部系统ID

---

id

id: string;

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

任务ID

---

maxDuration?

optional maxDuration?: number;

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

---

persistencePolicy?

optional persistencePolicy?: PersistencePolicy;

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

---

queue?

optional queue?: QueueConfig;

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

---

retry?

optional retry?: RetryConfig;

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

---

run

run: (payload, ctx) => Promise<TOutput>;

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

执行函数

Parameters

Parameter	Type
payload	SchedulePayload
ctx	TriggerContext

Returns

Promise<TOutput>

---

timezone?

optional timezone?: string;

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

时区，默认 UTC