Skip to main content

Class: TextField

Defined in: schema/fields.ts:63

TextField for full-text search

Extends​

Constructors​

Constructor​

new TextField(name, attrs?): TextField

Defined in: schema/fields.ts:64

Parameters​

name​

string

attrs?​

TextFieldAttrs = {}

Returns​

TextField

Overrides​

BaseField.constructor

Methods​

toRedisField()​

toRedisField(isJson): any

Defined in: schema/fields.ts:71

Convert this field to Redis schema field format. Each subclass must implement this method to return the appropriate Redis field type.

Parameters​

isJson​

boolean

Whether the index uses JSON storage (affects field naming with $.prefix)

Returns​

any

Overrides​

BaseField.toRedisField

Properties​

attrs​

readonly attrs: TextFieldAttrs = {}

Defined in: schema/fields.ts:66

Inherited from​

BaseField.attrs

name​

readonly name: string

Defined in: schema/fields.ts:30

Inherited from​

BaseField.name

path?​

optional path?: string | null

Defined in: schema/fields.ts:33

Inherited from​

BaseField.path

type​

readonly type: string

Defined in: schema/fields.ts:31

Inherited from​

BaseField.type