redis-om / Field
Describes a field in a Schema.
- caseSensitive
- hashField
- indexed
- isArray
- jsonPath
- matcher
- name
- normalized
- separator
- sortable
- stemming
- type
- weight
• new Field(name, definition)
Creates a Field.
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the Field. |
definition |
FieldDefinition |
The underlying FieldDefinition. |
• get caseSensitive(): boolean
The case-sensitivity of the field.
boolean
• get hashField(): string
The field name used to store this Field in a Hash.
string
• get indexed(): boolean
Indicates the field as being indexed—and thus queryable—by RediSearch.
boolean
• get isArray(): boolean
Is this type an array or not.
boolean
• get jsonPath(): string
The JSONPath used to store this Field in a JSON document.
string
• get matcher(): null | string
The phonetic matcher for the field.
null | string
• get name(): string
The name of the field.
string
• get normalized(): boolean
Indicates that the field is normalized. Ignored if sortable is false.
boolean
• get separator(): string
The separator for string[] fields when stored in Hashes.
string
• get sortable(): boolean
Indicates that the field as sortable.
boolean
• get stemming(): boolean
Indicates that the field as indexed with stemming support.
boolean
• get type(): FieldType
The type of the field.
• get weight(): null | number
The search weight of the field.
null | number