between( )

Refines a query to match items whose specified property value is within a specified range.

Description

The between() function refines a PublicPlansQueryBuilder 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. When sorting, ascending order is: numbers, followed by symbols, and then letters.

The following types of properties can be compared:

Number: Compares numerically.
Date: Compares JavaScript Date objects.
String: Compares lexicographically, so
- "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.

Syntax

function between(propertyName: string, rangeStart: string | number | Date, rangeEnd: string | number | Date): PublicPlansQueryBuilder

between Parameters

NAME

TYPE

DESCRIPTION

propertyName

string

The property whose value will be compared with rangeStart and rangeEnd.

Supported properties:

_createdDate
_updatedDate

rangeStart

string | number | Date

The beginning value of the range to match against.

rangeEnd

string | number | Date

The ending value of the range to match against.

Returns

A PublicPlansQueryBuilder object representing the refined query.

Return Type:

PublicPlansQueryBuilder

Was this helpful?

Add a "between" filter to a query

Copy Code

1const now = new Date();
2const date = new Date("2020-11-01");
3const query = wixPricingPlansBackend.queryPublicPlans().between("_createdDate", date, now);

Create a query, add a "between" filter, and run it

Copy Code

1import wixPricingPlansBackend from 'wix-pricing-plans-backend';
2
3// ...
4
5const now = new Date();
6const date = new Date("2021-01-01");
7
8wixPricingPlansBackend.queryPublicPlans()
9  .between("_createdDate", date, now)
10  .find()
11  .then((results) => {
12    if (results.items.length > 0) {
13      const items = results.items;
14      const firstItem = items[0];
15      const totalCount = results.totalCount;
16      const pageSize = results.pageSize;
17      const currentPage = results.currentPage;
18      const totalPages = results.totalPages;
19      const hasNext = results.hasNext();
20      const hasPrev = results.hasPrev();
21      const length = results.length;
22      const query = results.query;
23    } else {
24      // handle case where no matching items found
25    }
26  })
27  .catch((error) => {
28    const queryError = error;
29  });