eq( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Refines a search to match items whose specified field value equals the specified value.

The eq() method refines the search to only match items where the value of the specified field equals 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.

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

If the field contains an array, eq() matches the item if at least one array element equals the specified value.

Method Declaration
Copy
Method Parameters
fieldstringRequired

Field whose value is compared with value.


valueanyRequired

Value to match.

Returns
Return Type:WixDataSearch
Errors

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

Did this help?