ge( )

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

Description

The ge() function refines a ContactsQueryBuilder to only match items where the value of the specified property is greater 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,

"abc" is greater than or equal to "ABC" (because of the greater than), but "ABC" is not greater than or equal to "abc"

Syntax

function ge(propertyName: string, value: Date): ContactsQueryBuilder

ge Parameters

NAME

TYPE

DESCRIPTION

propertyName

string

The property whose value will be compared with value.

Supported properties:

"_createdDate"
"_updatedDate"
"lastActivity.activityDate"
"info.birthdate"

value

Date

The value to match against.

Returns

A ContactsQueryBuilder object that contains the refined query.

Return Type:

ContactsQueryBuilder

Was this helpful?

Add a ge filter to a query

Copy Code

1const query = contacts.queryContacts().ge("_createdDate", "2021-03-01");

Create a query, add a ge filter, and run it

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { contacts } from 'wix-crm-backend';
3
4export const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {
5  return contacts.queryContacts()
6    .ge("info.birthdate", "1983-02-01")
7    .find()
8    .then((results) => {
9      if (results.items.length > 0) {
10        const items = results.items;
11        const firstItem = items[0];
12        const pageSize = results.pageSize;
13        const hasNext = results.hasNext();
14        const hasPrev = results.hasPrev();
15        const length = results.length;
16        const query = results.query;
17
18        return items;
19      } else {
20        // Handle case where no matching items found
21      }
22    })
23    .catch((error) => {
24      console.error(error);
25    })
26
27});