PointFieldDefinition.md

redis-om / PointFieldDefinition

Interface: PointFieldDefinition

A field representing a point on the globe.

Hierarchy

• BaseFieldDefinition

  ↳ PointFieldDefinition

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.

Inherited from

BaseFieldDefinition.alias

Defined in

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

---

type

• type: "point"

Yep. It's a point.

Overrides

BaseFieldDefinition.type

Defined in

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