跳到主要内容

TriggerSchedule

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-schedule.ts:38

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

Extends

Constructors

Constructor

new TriggerSchedule(_initData?): TriggerSchedule;

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

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

Parameters

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

Returns

TriggerSchedule

Inherited from

EntityBase.constructor

Properties

active

active: boolean;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-schedule.ts:50

是否激活状态


catchUpPolicy

catchUpPolicy: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-schedule.ts:60

错过触发的处理策略:skip/once/replay-all


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


cron

cron: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-schedule.ts:42

Cron表达式(如 "0 * * * *" 表示每小时)


deduplicationKey?

optional deduplicationKey?: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-schedule.ts:48

去重键,确保同名调度唯一


externalId?

optional externalId?: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-schedule.ts:46

外部系统ID,用于关联外部数据


id

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

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

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

Inherited from

EntityBase.id


lastTick?

optional lastTick?: Date;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-schedule.ts:54

上一次触发时间(游标)


leaseUntil?

optional leaseUntil?: Date;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-schedule.ts:58

锁过期时间


lockedBy?

optional lockedBy?: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-schedule.ts:56

当前持有调度锁的标签页ID


nextTick?

optional nextTick?: Date;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-schedule.ts:52

下一次触发时间


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


taskId

taskId: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-schedule.ts:40

关联的任务ID


timezone

timezone: string;

Defined in: packages/rxdb-plugin-trigger/src/entities/trigger-schedule.ts:44

时区,默认UTC


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