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