BaseFieldDefinition.md

redis-om / BaseFieldDefinition

Interface: BaseFieldDefinition

Base interface for all fields.

Hierarchy

• BaseFieldDefinition

  ↳ BooleanFieldDefinition

  ↳ DateFieldDefinition

  ↳ NumberFieldDefinition

  ↳ PointFieldDefinition

  ↳ StringFieldDefinition

  ↳ StringArrayFieldDefinition

  ↳ TextFieldDefinition

Table of contents

Properties

• alias
• type

Properties

alias

• Optional alias: string

The default field name in Redis is the key name defined in the SchemaDefinition. Overrides the Redis key name if set.

Defined in

lib/schema/definition/base-field-definition.ts:12

---

type

• type: SchemaFieldType

The type of the field (i.e. string, number, boolean, etc.)

Defined in

lib/schema/definition/base-field-definition.ts:6