Home > @poq/sdk-sfcc > TextQuery
A text query is used to match some text (i.e. a search phrase possibly consisting of multiple terms) against one or multiple fields. In case multiple fields are provided, the phrase conceptually forms a logical OR over the fields. In this case, the terms of the phrase basically have to match within the text, that would result in concatenating all given fields.
Signature:
export declare class TextQuery extends BaseModel<TextQuery>
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the TextQuery class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| fields | Array<string> | The document fields the search phrase has to match against. | |
| searchPhrase | string | A search phrase, which may consist of multiple terms. |