跳到主要内容

EntityTriggerDefinition

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

EntityTriggerDefinition - 实体触发器定义

用于注册对特定实体变更的监听。

Properties​

debounce?​

optional debounce?: object;

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

防抖配置

delay​

delay: string | number;

key?​

optional key?: (payload) => string;

防抖键

Parameters​
ParameterType
payloadEntityTriggerPayload
Returns​

string

maxDelay?​

optional maxDelay?: string | number;

mode?​

optional mode?: "leading" | "trailing";

entity​

entity: string;

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

实体名称

filter?​

optional filter?: (payload) => boolean;

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

过滤函数，返回 true 才触发任务

Parameters​

ParameterType
payloadEntityTriggerPayload

Returns​

boolean

maxDepth?​

optional maxDepth?: number;

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

最大递归深度，超出后不触发

on​

on: 
  | EntityTriggerEvent
  | EntityTriggerEvent[];

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

监听的事件类型

payloadMapper?​

optional payloadMapper?: (payload) => unknown;

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

负载映射函数，转换后的负载传给任务

Parameters​

ParameterType
payloadEntityTriggerPayload

Returns​

unknown

taskId​

taskId: string;

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

关联的任务ID