跳到主要内容

EntityFieldConfig

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:29

实体字段配置

Properties​

displayName​

displayName: string;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:33

显示名称

encrypted?​

optional encrypted?: boolean;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:66

是否为加密列 仅在元数据声明 encrypted: true 时输出该键

enumValues?​

optional enumValues?: readonly string[];

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:45

枚举类型的可选值

field​

field: string;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:31

字段名

format?​

optional format?: FieldFormat;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:56

字段语义标注（只影响展示与控件选择，不改变运行时值类型） 仅在元数据声明 format 时输出该键

keyValueSchema?​

optional keyValueSchema?: Record<string, KeyValueSchemaEntry>;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:47

键值类型字段的 Schema

nullable?​

optional nullable?: boolean;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:39

是否可为空

options?​

optional options?: Readonly<Record<string, FieldOptionDisplay>>;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:61

枚举/多选值的展示元数据（label / color / disabled），键是 enum 的子集 仅在元数据声明 options 时输出该键

readonly?​

optional readonly?: boolean;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:37

是否只读

relatedEntityName?​

optional relatedEntityName?: string;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:49

关系字段关联的实体名

relatedNamespace?​

optional relatedNamespace?: string;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:51

关系字段关联实体的命名空间

required?​

optional required?: boolean;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:41

是否必填

type​

type: EntityFieldType;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:35

字段类型

unique?​

optional unique?: boolean;

Defined in: packages/rxdb-model/dist/entity-field.utils.d.ts:43

是否唯一