BooleanFieldDefinition.md

redis-om / BooleanFieldDefinition

Interface: BooleanFieldDefinition

A field representing a boolean.

Hierarchy

• BaseFieldDefinition

• SortableFieldDefinition

  ↳ BooleanFieldDefinition

Table of contents

Properties

• alias
• sortable
• 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

---

sortable

• Optional sortable: boolean

Enables sorting by this field.

Inherited from

SortableFieldDefinition.sortable

Defined in

lib/schema/definition/sortable-field-definition.ts:4

---

type

• type: "boolean"

Yep. It's a boolean.

Overrides

BaseFieldDefinition.type

Defined in

lib/schema/definition/boolean-field-definition.ts:7