SchedulesAPI
Defined in: packages/rxdb-plugin-trigger/src/types.ts:559
SchedulesAPI - 调度管理接口
Methods
activate()
activate(scheduleId): Promise<void>;
Defined in: packages/rxdb-plugin-trigger/src/types.ts:571
激活调度
Parameters
| Parameter | Type |
|---|---|
scheduleId | string |
Returns
Promise<void>
create()
create(options): Promise<ScheduleInfo>;
Defined in: packages/rxdb-plugin-trigger/src/types.ts:563
创建调度
Parameters
| Parameter | Type |
|---|---|
options | ScheduleCreateOptions |
Returns
Promise<ScheduleInfo>
deactivate()
deactivate(scheduleId): Promise<void>;
Defined in: packages/rxdb-plugin-trigger/src/types.ts:573
停用调度
Parameters
| Parameter | Type |
|---|---|
scheduleId | string |
Returns
Promise<void>
del()
del(scheduleId): Promise<void>;
Defined in: packages/rxdb-plugin-trigger/src/types.ts:575
删除调度
Parameters
| Parameter | Type |
|---|---|
scheduleId | string |
Returns
Promise<void>
list()
list(taskId?): Promise<ScheduleInfo[]>;
Defined in: packages/rxdb-plugin-trigger/src/types.ts:567
列出调度
Parameters
| Parameter | Type |
|---|---|
taskId? | string |
Returns
Promise<ScheduleInfo[]>
retrieve()
retrieve(scheduleId): Promise<ScheduleInfo | undefined>;
Defined in: packages/rxdb-plugin-trigger/src/types.ts:565
获取调度详情
Parameters
| Parameter | Type |
|---|---|
scheduleId | string |
Returns
Promise<ScheduleInfo | undefined>
task()
task<TPayload, TOutput>(def): TaskHandle<TPayload, TOutput>;
Defined in: packages/rxdb-plugin-trigger/src/types.ts:561
定义定时任务，返回任务句柄
Type Parameters
| Type Parameter | Default type |
|---|---|
TPayload | unknown |
TOutput | unknown |
Parameters
| Parameter | Type |
|---|---|
def | ScheduleTaskDefinition<TOutput> |
Returns
TaskHandle<TPayload, TOutput>
update()
update(scheduleId, options): Promise<ScheduleInfo>;
Defined in: packages/rxdb-plugin-trigger/src/types.ts:569
更新调度
Parameters
| Parameter | Type |
|---|---|
scheduleId | string |
options | ScheduleUpdateOptions |
Returns
Promise<ScheduleInfo>