le( )
Refines a search or filter to match documents whose specified field value is less than or equal to the specified value.
Description
The le()
function refines a WixSearchBuilder
to only match
documents where the value of the specified field is less than or equal to the
specified value
.
le()
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 properties can be compared:
- Number: Compares numerically.
- Date: Compares JavaScript Date objects.
- String: Compares lexicographically, so
"Text"
is less than or equal to"text"
(because of the 'less than').
If other filters were previously used in the same WixSearchBuilder
instance, le()
is applied using an and
condition with previously set filters.
Syntax
function le(field: string, value: string | number | Date): WixSearchBuilder
le Parameters
NAME
TYPE
DESCRIPTION
The field whose value will be compared with value
.
The value to match against.
Was this helpful?
1let newSearch = search2 .documentType("Forum/Content")3 .le("viewCount", 50);
1import wixSearch from 'wix-search';23// ...45wixSearch.search()6 .documentType("Forum/Content")7 .le("totalComments", 5)8 .find()9 .then( (results) => {10 if(results.documents.length > 0) {11 let documents = results.documents;12 } else {13 console.log("No matching results");14 }15 })16 .catch( (error) => {17 console.log(error);18 });