le( )

Refines a query to match items whose specified property value is less than or equal to the specified value.

The le() function refines a BookingsQueryBuilderto only match items where the value of the specified property is less than or equal to the specified value.

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:

  • Number: Compares numerically.
  • Date: Compares JavaScript Date objects.
  • String: Compares lexicographically, so "ABC" is less than or equal to "abc" (because of the less than), but "abc" is not less than or equal to "ABC".
Method Declaration
Copy
function le(propertyName: string, value: union): BookingsQueryBuilder;
Method Parameters
propertyNamestringRequired

The property whose value will be compared with value.

Supported properties:

  • endTime
valueunionRequired

The value to match against.

Returns
Return Type:BookingsQueryBuilder
JavaScript
let query = bookings.queryBookings().le("endTime", "2021-04-27T10:00:00.000Z");
Did this help?

limit( )

Limits the number of items the query returns.

The limit() function defines the number of results a query returns in each page. Only one page of results is retrieved at a time. The next() and prev() functions are used to navigate the pages of a query result.

By default, limit is set to 50.

The maximum value that limit() can accept is 1000.

Method Declaration
Copy
function limit(limit: number): BookingsQueryBuilder;
Method Parameters
limitnumberRequired

The number of items to return, which is also the pageSize of the results object.

Returns
Return Type:BookingsQueryBuilder
JavaScript
let query = bookings.queryBookings().limit(10);
Did this help?

lt( )

Refines a query to match items whose specified property value is less than the specified value.

The lt() function refines a BookingsQueryBuilder to only match items where the value of the specified property is less than the specified value.

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:

  • Number: Compares numerically.
  • Date: Compares JavaScript Date objects.
  • String: Compares lexicographically, so "Text" is less than "text".
Method Declaration
Copy
function lt(propertyName: string, value: union): BookingsQueryBuilder;
Method Parameters
propertyNamestringRequired

The property whose value will be compared with value.

Supported properties:

  • startTime
  • _createdDate
valueunionRequired

The value to match against.

Returns
Return Type:BookingsQueryBuilder
JavaScript
let query = bookings
  .queryBookings()
  .lt("startTime", "2021-04-27T10:00:00.000Z");
Did this help?

skip( )

Sets the number of items to skip before returning query results.

The skip() function defines the number of results to skip in the query results before returning new query results.

For example, if you query a collection and 50 items match your query, but you set skip to 10, the results returned will skip the first 10 items that match and return the 11th through 50th items.

By default, skip is set to 0.

Method Declaration
Copy
function skip(skip: number): BookingsQueryBuilder;
Method Parameters
skipnumberRequired

The number of items to skip in the query results before returning the results.

Returns
Return Type:BookingsQueryBuilder
JavaScript
let query = bookings.queryBookings().skip(10);
Did this help?