Class: IndexInfo

Defined in: schema/schema.ts:82

IndexInfo includes the essential details regarding index settings, such as its name, prefix, key separator, storage type, and stopwords in Redis.

Constructors

Constructor

new IndexInfo(options): IndexInfo

Defined in: schema/schema.ts:94

Parameters

options

input

Returns

IndexInfo

Properties

keySeparator

readonly keySeparator: string

Defined in: schema/schema.ts:88

The separator character used in designing Redis keys

---

name

readonly name: string

Defined in: schema/schema.ts:84

The unique name of the index

---

prefix

readonly prefix: string | string[]

Defined in: schema/schema.ts:86

The prefix(es) used for Redis keys associated with this index

---

stopwords?

readonly optional stopwords?: string[]

Defined in: schema/schema.ts:92

Index-level stopwords configuration

---

storageType

readonly storageType: StorageType

Defined in: schema/schema.ts:90

The storage type used in Redis (e.g., StorageType.HASH or StorageType.JSON)