跳到主要内容

TaskHandle<TPayload, TOutput>

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

TaskHandle - 任务操作句柄

通过 plugin.task() 注册任务后返回的句柄。

Type Parameters

Type ParameterDefault type
TPayloadunknown
TOutputunknown

Properties

id

id: string;

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

任务ID

Methods

batchTrigger()

batchTrigger(items, options?): Promise<BatchHandle>;

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

批量触发

Parameters

ParameterType
itemsBatchItem<TPayload>[]
options?TriggerOptions

Returns

Promise<BatchHandle>


batchTriggerAndWait()

batchTriggerAndWait(items, options?): Promise<Result<TOutput>[]>;

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

批量触发并等待全部完成

Parameters

ParameterType
itemsBatchItem<TPayload>[]
options?TriggerOptions

Returns

Promise<Result<TOutput>[]>


trigger()

trigger(payload, options?): Promise<RunHandle>;

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

触发任务执行(异步)

Parameters

ParameterType
payloadTPayload
options?TriggerOptions

Returns

Promise<RunHandle>


triggerAndWait()

triggerAndWait(payload, options?): Promise<Result<TOutput>>;

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

触发并等待完成

Parameters

ParameterType
payloadTPayload
options?TriggerOptions

Returns

Promise<Result<TOutput>>