Home > @poq/sdk-sfcc > TermQuery
A term query matches one (or more) value(s) against one (or more) document field(s). A document is considered a hit if one of the values matches (exactly) with at least one of the given fields. The operator “is” can only take one value, while “one_of” can take multiple values. If multiple fields are specified, they are combined using the OR operator. The
Signature:
export declare class TermQuery extends BaseModel<TermQuery>
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the TermQuery class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| fields | Array<string> | The document field(s), the value(s) are matched against, combined with the operator. | |
| operator | TermQueryOperatorEnum | Returns the operator to use for the term query. | |
| values? | Array<object> | (Optional) The values, the field(s) are compared against, combined with the operator. |