跳到主要内容

Entity()

function Entity(metadataOptions): <T>(target) => T;

Defined in: packages/rxdb/src/entity/@Entity.ts:34

实体装饰器 用于将类标记为 RxDB 实体,并处理元数据、代理和生命周期

该装饰器会:

  1. 转换并存储实体元数据
  2. 处理实体的默认值和初始值
  3. 为实体创建代理,以支持变更跟踪和关系管理
  4. 处理抽象实体和具体实体的不同行为

Parameters

ParameterTypeDescription
metadataOptionsEntityMetadataOptions实体元数据选项,包含名称、显示名称、属性、关系、索引等配置

Returns

类装饰器函数

<T>(target): T;

Type Parameters

Type Parameter
T extends | EntityType | AbstractEntityType

Parameters

ParameterType
targetT

Returns

T

Example

// 基本用法
@Entity({ name: 'User' })
class User extends EntityBase {}