跳到主要内容

EntityFieldConfig

Defined in: packages/rxdb-model/src/entity-field.utils.ts:57

实体字段配置

Properties​

displayName​

displayName: string;

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

显示名称


encrypted?​

optional encrypted?: boolean;

Defined in: packages/rxdb-model/src/entity-field.utils.ts:94

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


enumValues?​

optional enumValues?: readonly string[];

Defined in: packages/rxdb-model/src/entity-field.utils.ts:73

枚举类型的可选值


field​

field: string;

Defined in: packages/rxdb-model/src/entity-field.utils.ts:59

字段名


format?​

optional format?: FieldFormat;

Defined in: packages/rxdb-model/src/entity-field.utils.ts:84

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


keyValueSchema?​

optional keyValueSchema?: Record<string, KeyValueSchemaEntry>;

Defined in: packages/rxdb-model/src/entity-field.utils.ts:75

键值类型字段的 Schema


nullable?​

optional nullable?: boolean;

Defined in: packages/rxdb-model/src/entity-field.utils.ts:67

是否可为空


options?​

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

Defined in: packages/rxdb-model/src/entity-field.utils.ts:89

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


readonly?​

optional readonly?: boolean;

Defined in: packages/rxdb-model/src/entity-field.utils.ts:65

是否只读


relatedEntityName?​

optional relatedEntityName?: string;

Defined in: packages/rxdb-model/src/entity-field.utils.ts:77

关系字段关联的实体名


relatedNamespace?​

optional relatedNamespace?: string;

Defined in: packages/rxdb-model/src/entity-field.utils.ts:79

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


required?​

optional required?: boolean;

Defined in: packages/rxdb-model/src/entity-field.utils.ts:69

是否必填


type​

type: EntityFieldType;

Defined in: packages/rxdb-model/src/entity-field.utils.ts:63

字段类型


unique?​

optional unique?: boolean;

Defined in: packages/rxdb-model/src/entity-field.utils.ts:71

是否唯一