redis-om / StringFieldDefinition
A field representing a whole string.
-
↳
StringFieldDefinition
• Optional alias: string
The default field name in Redis is the key name defined in the SchemaDefinition. Overrides the Redis key name if set.
lib/schema/definition/base-field-definition.ts:12
• 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 |.
SeparableFieldDefinition.separator
lib/schema/definition/separable-field-definition.ts:9
• Optional sortable: boolean
Enables sorting by this field.
SortableFieldDefinition.sortable
lib/schema/definition/sortable-field-definition.ts:4
• type: "string"
Yep. It's a string.