eq( )

Creates a search filter for matching documents whose specified field value equals the specified value.

Description

The eq() 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 equals the specified value.

eq() 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.

Matching strings with eq() is case sensitive, so "text" is not equal to "Text".

Syntax

function eq(field: string, value: *): WixSearchFilter

eq Parameters

NAME

TYPE

DESCRIPTION

field

string

The field whose value will be compared with value.

value

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 an equals search filter

Copy Code

1import wixSearch from 'wix-search';
2
3// ...
4
5const eqFilter = wixSearch
6  .filter()
7  .eq("sku", "SHO-11-BLA");

Create filters and add them to a search

This example demonstrates how to create filters that search for forum posts in a specific forum category, that contain the hashtags "summer" and "fun", and that were posted/updated on or after January 1, 2020. The filters are joined and chained to a search using an and() filter.

Copy Code

1import wixSearch from 'wix-search';
2
3// ...
4
5const filterBuilder = wixSearch.filter();
6
7const gtFilter = filterBuilder.gt("lastActivityDate", "2020-01-01T00:00:00.000Z");
8
9const hasAllFilter = filterBuilder.hasAll("hashTags", ["summer", "fun"]);
10
11const eqFilter = filterBuilder.eq(categoryId, "5df7504fa8a9b30017fc1053");
12
13wixSearch.search(phrase)
14  .documentType("Forum/Content")
15  .and(gtFilter, hasAllFilter, eqFilter)
16  .find()
17  .then( (results) => {
18    if(results.documents.length > 0) {
19      let documents = results.documents;
20    } else {
21      console.log("No matching results");
22    }
23  })
24  .catch( (error) => {
25    console.log(error);
26  });