跳到主要内容

EntityPropertyFieldDescriptor

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

普通属性与系统字段的描述。

Extends​

  • EntityFieldDescriptorBase

Properties​

cardinality​

cardinality: FieldCardinality;

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

Inherited from​

EntityFieldDescriptorBase.cardinality

displayName​

displayName: string;

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

Inherited from​

EntityFieldDescriptorBase.displayName

encrypted​

encrypted: boolean;

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

Inherited from​

EntityFieldDescriptorBase.encrypted

enum?​

optional enum?: readonly string[];

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

Inherited from​

EntityFieldDescriptorBase.enum

field​

field: string;

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

Inherited from​

EntityFieldDescriptorBase.field

format?​

optional format?: FieldFormat;

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

Inherited from​

EntityFieldDescriptorBase.format

keyValueSchema?​

optional keyValueSchema?: Record<string, KeyValueSchemaEntry>;

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

Inherited from​

EntityFieldDescriptorBase.keyValueSchema

nullable​

nullable: boolean;

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

Inherited from​

EntityFieldDescriptorBase.nullable

options?​

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

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

Inherited from​

EntityFieldDescriptorBase.options

primary?​

optional primary?: boolean;

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

Inherited from​

EntityFieldDescriptorBase.primary

readonly​

readonly: boolean;

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

Inherited from​

EntityFieldDescriptorBase.readonly

relation?​

optional relation?: undefined;

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

required​

required: boolean;

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

Inherited from​

EntityFieldDescriptorBase.required

searchable?​

optional searchable?: boolean;

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

Inherited from​

EntityFieldDescriptorBase.searchable

sortable?​

optional sortable?: boolean;

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

Inherited from​

EntityFieldDescriptorBase.sortable

source​

source: "property" | "system";

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

unique​

unique: boolean;

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

Inherited from​

EntityFieldDescriptorBase.unique

valueType​

valueType: 
  | "string"
  | "number"
  | "bigint"
  | "boolean"
  | "date"
  | "uuid"
  | "enum"
  | "integer"
  | "binary"
  | "stringArray"
  | "numberArray"
  | "keyValue"
  | "json";

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

Inherited from​

EntityFieldDescriptorBase.valueType