跳到主要内容

TriggerRun

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:62

实体基类装饰器配置 定义了所有实体共有的基础属性

Extends​

Constructors​

Constructor​

new TriggerRun(_initData?): TriggerRun;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:96

实体基类构造函数 子类会通过 Entity 装饰器增强此构造函数

Parameters​

ParameterTypeDescription
_initData?any可选的初始化数据

Returns​

TriggerRun

Inherited from​

EntityBase.constructor

Properties​

attempt​

attempt: number;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:74

当前尝试次数（重试计数）

batchId?​

optional batchId?: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:78

所属批次ID（批量触发时使用）

cancelRequestedAt?​

optional cancelRequestedAt?: Date;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:110

取消请求时间戳

completedAt?​

optional completedAt?: Date;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:100

执行完成时间

concurrencyKey?​

optional concurrencyKey?: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:82

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

createdAt​

readonly createdAt: Date;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:20

创建时间 实体创建时自动设置为当前时间

Inherited from​

EntityBase.createdAt

createdBy?​

readonly optional createdBy?: `${string}-${string}-${string}-${string}-${string}` | null;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:30

创建者ID 记录创建此实体的用户ID

Inherited from​

EntityBase.createdBy

duration?​

optional duration?: number;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:94

执行耗时（毫秒）

error?​

optional error?: unknown;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:72

错误信息（序列化后的结构）

expiresAt?​

optional expiresAt?: Date;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:108

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

id​

readonly id: `${string}-${string}-${string}-${string}-${string}`;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:15

实体唯一标识符 自动生成的UUID，作为主键

Inherited from​

EntityBase.id

idempotencyKey?​

optional idempotencyKey?: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:80

幂等性键，用于防止重复触发

leaseUntil?​

optional leaseUntil?: Date;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:106

分布式锁过期时间

lockedBy?​

optional lockedBy?: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:104

分布式锁持有者标识

maxAttempts​

maxAttempts: number;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:76

最大尝试次数

metadata?​

optional metadata?: Record<string, unknown>;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:86

元数据，可存储业务自定义信息

output?​

optional output?: unknown;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:70

任务执行结果输出

payload?​

optional payload?: unknown;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:68

任务入参payload

persistencePolicy​

persistencePolicy: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:88

持久化策略：full-完整保留, metadata-only-仅元数据, none-不保留

priority​

priority: number;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:112

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

progress?​

optional progress?: number;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:90

执行进度百分比（0-100）

progressMessage?​

optional progressMessage?: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:92

进度描述信息

remove​

remove: () => Promise<any>;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:81

删除

Returns​

Promise<any>

Inherited from​

EntityBase.remove

reset​

reset: () => void;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:85

重置数据

Returns​

void

Inherited from​

EntityBase.reset

save​

save: () => Promise<any>;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:89

保存

Returns​

Promise<any>

Inherited from​

EntityBase.save

scheduledAt?​

optional scheduledAt?: Date;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:96

计划执行时间（用于延迟任务）

startedAt?​

optional startedAt?: Date;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:98

实际开始执行时间

status​

status: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:66

当前运行状态

tabId?​

optional tabId?: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:102

正在执行该任务的标签页ID

tags?​

optional tags?: string[];

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:84

标签数组，用于分组筛选

taskId​

taskId: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-run.ts:64

关联的任务ID

updatedAt​

readonly updatedAt: Date;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:25

更新时间 实体创建或更新时自动设置为当前时间

Inherited from​

EntityBase.updatedAt

updatedBy?​

readonly optional updatedBy?: `${string}-${string}-${string}-${string}-${string}` | null;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:35

更新者ID 记录最后更新此实体的用户ID

Inherited from​

EntityBase.updatedBy

count​

static count: <T>(this, options) => Observable<number>;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:77

查询实体数量

Type Parameters​

Type Parameter
T extends EntityBase

Parameters​

ParameterTypeDescription
this() => T-
optionsCountOptions<() => T>查询选项，包含 where 条件

Returns​

Observable<number>

Observable 包装的数量

Inherited from​

EntityBase.count

find​

static find: <T>(this, options) => Observable<T[]>;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:59

查询多个实体

Type Parameters​

Type Parameter
T extends EntityBase

Parameters​

ParameterTypeDescription
this() => T-
optionsFindOptions<() => T>查询选项，包含 where 条件、limit、offset 等

Returns​

Observable<T[]>

Observable 包装的实体实例数组

Inherited from​

EntityBase.find

findAll​

static findAll: <T>(this, options) => Observable<T[]>;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:65

查询所有实体

Type Parameters​

Type Parameter
T extends EntityBase

Parameters​

ParameterTypeDescription
this() => T-
optionsFindAllOptions<() => T>查询选项，包含 where 条件和排序（不限制数量）

Returns​

Observable<T[]>

Observable 包装的实体实例数组

Inherited from​

EntityBase.findAll

findByCursor​

static findByCursor: <T>(this, options) => Observable<T[]>;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:71

通过游标进行分页查询

Type Parameters​

Type Parameter
T extends EntityBase

Parameters​

ParameterTypeDescription
this() => T-
optionsFindByCursorOptions<() => T>游标分页选项，包含 orderBy、before/after 游标

Returns​

Observable<T[]>

Observable 包装的实体实例数组

Inherited from​

EntityBase.findByCursor

findOne​

static findOne: <T>(this, options) => Observable<T | null>;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:47

查找一个实体

Type Parameters​

Type Parameter
T extends EntityBase

Parameters​

ParameterTypeDescription
this() => T-
optionsFindOneOptions<() => T>查询选项，包含 where 条件

Returns​

Observable<T | null>

Observable 包装的实体实例或 null

Inherited from​

EntityBase.findOne

findOneOrFail​

static findOneOrFail: <T>(this, options) => Observable<T>;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:53

查找一个实体，查不到就抛出错误

Type Parameters​

Type Parameter
T extends EntityBase

Parameters​

ParameterTypeDescription
this() => T-
optionsFindOneOrFailOptions<() => T>查询选项，包含 where 条件

Returns​

Observable<T>

Observable 包装的实体实例

Inherited from​

EntityBase.findOneOrFail

get​

static get: <T>(this, id) => Observable<T>;

Defined in: packages/rxdb/dist/entity/EntityBase.d.ts:41

根据 id 获取实体

Type Parameters​

Type Parameter
T extends EntityBase

Parameters​

ParameterTypeDescription
this() => T-
id`${string}-${string}-${string}-${string}-${string}`实体的唯一标识符

Returns​

Observable<T>

Observable 包装的实体实例

Inherited from​

EntityBase.get