ge( )

Creates a search filter for matching documents whose specified field value is greater than or equal to the specified value.

Description

The ge() function is chained to a WixSearchFilterBuilder to create a WixSearchFilter. You can use the filter to match documents where the value of the specified field is greater than or equal to the specified value.

ge() 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 field contains a number as a String, that value will be compared alphabetically and not numerically. Documents that do not have a value for the specified field are ranked lowest.

The following types of fields can be compared:

Number: Compares numerically.
Date: Compares JavaScript Date objects.
String: Compares lexicographically, so "text" is greater than or equal to "Text" (because of the 'greater than').

Syntax

function ge(field: string, value: string | number | Date): WixSearchFilter

ge Parameters

NAME

TYPE

DESCRIPTION

field

string

The field whose value will be compared with value.

value

string | number | Date

The value to match against.

Returns

A WixSearchFilter object.

Return Type:

WixSearchFilter

NAME

TYPE

DESCRIPTION

filterDefinition

Object

An object containing the filter definition.

Was this helpful?

Create a greater than or equals search filter

Copy Code

1import wixSearch from 'wix-search';
2
3// ...
4
5const geFilter = wixSearch
6  .filter()
7  .ge("viewCount", 50);

Create multiple filters and combine them

This example demonstrates how to create filters for searching for popular forum posts with 20 or more likes and 100 or more views.

Copy Code

1import wixSearch from 'wix-search';
2
3// ...
4
5const filterBuilder = wixSearch.filter();
6
7const geLikeFilter = filterBuilder.ge("likeCount", 20);
8
9const geViewFilter = filterBuilder.ge("viewCount", 100);
10
11const andFilter = filterBuilder.and(geLikeFilter, geViewFilter);