le( )

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

Description

The le() function refines an EventsQueryBuilder to 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".

Syntax

function le(propertyName: string, value: string | number | Date): EventsQueryBuilder

le Parameters

NAME

TYPE

DESCRIPTION

propertyName

string

The property whose value will be compared with value.

Supported properties:

scheduling.startDate
scheduling.endDate
title
slug

value

string | number | Date

The value to match against.

Returns

Contains functionality for refining a Wix events query.

Return Type:

EventsQueryBuilder

Was this helpful?

Add a "less than or equals" filter to a query

Copy Code

1const query = wixEvents.queryEvents().le("_updatedDate", "2021-01-27T10:00:00.000Z");

Create a query, add a "less than or equals" filter, and run it

Copy Code

1import { wixEvents } from 'wix-events-backend';
2
3// ...
4
5wixEvents.queryEvents()
6  .le("_updatedDate", "2021-01-27T10:00:00.000Z")
7  .find()
8  .then((results) => {
9    if (results.items.length > 0) {
10      const items = results.items;
11      const firstItem = items[0];
12      const totalCount = results.totalCount;
13      const pageSize = results.pageSize;
14      const currentPage = results.currentPage;
15      const totalPages = results.totalPages;
16      const hasNext = results.hasNext();
17      const hasPrev = results.hasPrev();
18      const length = results.length;
19      const query = results.query;
20    } else {
21      // handle case where no matching items found
22    }
23  })
24  .catch((error) => {
25    const queryError = error;
26  });