eq( )


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

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".

Method Declaration
Copy
function eq(field: string, value: any): WixSearchFilter;
Method Parameters
fieldstringRequired

The field whose value will be compared with value.


valueanyRequired

The value to match against.

Returns
Return Type:WixSearchFilter
JavaScript
import wixSearch from "wix-search"; // ... const eqFilter = wixSearch.filter().eq("sku", "SHO-11-BLA");
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?