Home > @poq/sdk-sfcc > Range2Filter
Document representing a range compare with range filter, named Range2Filter.
Signature:
export declare class Range2Filter extends BaseModel<Range2Filter>
Extends: BaseModel<Range2Filter
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the Range2Filter class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| filterMode? | Range2FilterFilterModeEnum | (Optional) Compare mode: overlap, containing, or contained. If not specified, the default is overlap. | |
| fromField | string | The field name of the field that starts the first range. | |
| fromInclusive? | boolean | (Optional) Indicates whether the lower bound of the second range is inclusive. If not specified, the default is true. Set to false to make the lower bound exclusive. | |
| fromValue? | object | (Optional) The lower bound of the second range. If not specified, the range is open-ended with respect to the lower bound. You can’t leave both the lower and upper bounds open-ended. | |
| toField | string | The field name of the field that ends the first range. | |
| toInclusive? | boolean | (Optional) Indicates whether the upper bound of the second range is inclusive. If not specified, the default is true. Set to false to make the lower bound exclusive. | |
| toValue? | object | (Optional) The upper bound of the second range. If not specified, the range is open-ended with respect to the upper bound. You can’t leave both the upper and lower bounds open-ended. |