Skip to content

Latest commit

 

History

History
73 lines (40 loc) · 1.98 KB

File metadata and controls

73 lines (40 loc) · 1.98 KB

redis-om / StringArrayFieldDefinition

Interface: StringArrayFieldDefinition

A field representing an array of strings.

Hierarchy

Table of contents

Properties

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


separator

Optional separator: string

Due to how RediSearch works, strings and arrays are sometimes stored the same in Redis, as a simple string. This is the separator used to split those strings when it is an array. If your StringField contains this separator, this can cause problems. You can change it here to avoid those problems. Defaults to |.

Inherited from

SeparableFieldDefinition.separator

Defined in

lib/schema/definition/separable-field-definition.ts:9


type

type: "string[]"

Yep. It's a string array.

Overrides

BaseFieldDefinition.type

Defined in

lib/schema/definition/string-array-field-definition.ts:7