EntityBase<Id>
Defined in: packages/rxdb/src/entity/entity-base.ts:100
实体基类 所有需要同步的实体都应该继承此类
提供通用的实体属性，如ID、创建时间、更新时间等 自动处理这些字段的默认值和只读属性
Example
@Entity({ name: 'User' })
class User extends EntityBase {
}
Implements
实现实体接口
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
Id extends RxDBEntityId | UUID |
Implements
Constructors
Constructor
new EntityBase<Id>(initData?): EntityBase<Id>;
Defined in: packages/rxdb/src/entity/entity-base.ts:217
实体基类构造函数 子类会通过 Entity 装饰器增强此构造函数
Parameters
| Parameter | Type |
|---|---|
initData? | unknown |
Returns
EntityBase<Id>
Properties
createdAt
readonly createdAt: Date;
Defined in: packages/rxdb/src/entity/entity-base.ts:111
创建时间 实体创建时自动设置为当前时间
Implementation of
createdBy?
readonly optional createdBy?: `${string}-${string}-${string}-${string}-${string}` | null;
Defined in: packages/rxdb/src/entity/entity-base.ts:123
创建者ID 记录创建此实体的用户ID
Implementation of
id
readonly id: Id;
Defined in: packages/rxdb/src/entity/entity-base.ts:105
实体唯一标识符 自动生成的UUID，作为主键
Implementation of
remove
remove: () => Promise<EntityBase<Id>>;
Defined in: packages/rxdb/src/entity/entity-base.ts:201
删除
Returns
Promise<EntityBase<Id>>
reset
reset: () => void;
Defined in: packages/rxdb/src/entity/entity-base.ts:205
重置数据
Returns
void
save
save: () => Promise<EntityBase<Id>>;
Defined in: packages/rxdb/src/entity/entity-base.ts:209
保存
Returns
Promise<EntityBase<Id>>
updatedAt
readonly updatedAt: Date;
Defined in: packages/rxdb/src/entity/entity-base.ts:117
更新时间 实体创建或更新时自动设置为当前时间
Implementation of
updatedBy?
readonly optional updatedBy?: `${string}-${string}-${string}-${string}-${string}` | null;
Defined in: packages/rxdb/src/entity/entity-base.ts:129
更新者ID 记录最后更新此实体的用户ID
Implementation of
count
static count: <T>(this, options) => Observable<number>;
Defined in: packages/rxdb/src/entity/entity-base.ts:193
查询实体数量
Type Parameters
| Type Parameter |
|---|
T extends EntityBase<RxDBEntityId> |
Parameters
| Parameter | Type | Description |
|---|---|---|
this | () => T | - |
options | CountOptions<() => T> | 查询选项，包含 where 条件 |
Returns
Observable<number>
Observable 包装的数量
find
static find: <T>(this, options) => Observable<T[]>;
Defined in: packages/rxdb/src/entity/entity-base.ts:163
查询多个实体
Type Parameters
| Type Parameter |
|---|
T extends EntityBase<RxDBEntityId> |
Parameters
| Parameter | Type | Description |
|---|---|---|
this | () => T | - |
options | FindOptions<() => T> | 查询选项，包含 where 条件、limit、offset 等 |
Returns
Observable<T[]>
Observable 包装的实体实例数组
findAll
static findAll: <T>(this, options) => Observable<T[]>;
Defined in: packages/rxdb/src/entity/entity-base.ts:173
查询所有实体
Type Parameters
| Type Parameter |
|---|
T extends EntityBase<RxDBEntityId> |
Parameters
| Parameter | Type | Description |
|---|---|---|
this | () => T | - |
options | FindAllOptions<() => T> | 查询选项，包含 where 条件和排序（不限制数量） |
Returns
Observable<T[]>
Observable 包装的实体实例数组
findByCursor
static findByCursor: <T>(this, options) => Observable<T[]>;
Defined in: packages/rxdb/src/entity/entity-base.ts:183
通过游标进行分页查询
Type Parameters
| Type Parameter |
|---|
T extends EntityBase<RxDBEntityId> |
Parameters
| Parameter | Type | Description |
|---|---|---|
this | () => T | - |
options | FindByCursorOptions<() => T> | 游标分页选项，包含 orderBy、before/after 游标 |
Returns
Observable<T[]>
Observable 包装的实体实例数组
findOne
static findOne: <T>(this, options) => Observable<T | null>;
Defined in: packages/rxdb/src/entity/entity-base.ts:143
查找一个实体
Type Parameters
| Type Parameter |
|---|
T extends EntityBase<RxDBEntityId> |
Parameters
| Parameter | Type | Description |
|---|---|---|
this | () => T | - |
options | FindOneOptions<() => T> | 查询选项，包含 where 条件 |
Returns
Observable<T | null>
Observable 包装的实体实例或 null
findOneOrFail
static findOneOrFail: <T>(this, options) => Observable<T>;
Defined in: packages/rxdb/src/entity/entity-base.ts:153
查找一个实体，查不到就抛出错误
Type Parameters
| Type Parameter |
|---|
T extends EntityBase<RxDBEntityId> |
Parameters
| Parameter | Type | Description |
|---|---|---|
this | () => T | - |
options | FindOneOrFailOptions<() => T> | 查询选项，包含 where 条件 |
Returns
Observable<T>
Observable 包装的实体实例
get
static get: <T>(this, id) => Observable<T>;
Defined in: packages/rxdb/src/entity/entity-base.ts:136
根据 id 获取实体
Type Parameters
| Type Parameter |
|---|
T extends EntityBase<RxDBEntityId> |
Parameters
| Parameter | Type | Description |
|---|---|---|
this | () => T | - |
id | T["id"] | 实体的唯一标识符 |
Returns
Observable<T>
Observable 包装的实体实例