Refines a query to match items whose specified property value is within a specified range.
The between()
function refines a ContactsQueryBuilder
to only
match items where the value of the specified property is greater than or equal
to rangeStart
and less than rangeEnd
.
It only matches values of the same type. For example, a number value stored as a String type does not match the same number stored as a Number type.
If a property contains a number as a String, that value will be compared alphabetically and not numerically. Items that do not have a value for the specified property are ranked lowest.
The following types of properties can be compared:
"A"
and "M"
are between "A"
and "Z"
, but "a"
, "m"
, "z"
and "Z"
are not."A"
, "M"
, "Z"
, and "a"
are between "A"
and "z"
, but "z"
is not.function between(
propertyName: string,
rangeStart: Date,
rangeEnd: Date,
): ContactsQueryBuilder;
The property whose value will be compared to rangeStart
and rangeEnd
.
Supported properties:
_createdDate
_updatedDate
lastActivity.activityDate
info.birthdate
The value to match against.
The value to match against.
const query = contacts
.queryContacts()
.between("_createdDate", "2020-07-01", "2020-12-31");
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.