contains( )


Developer Preview

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

Filters pipeline data to match items where the value of the specified field contains the specified value.

The contains() method refines the aggregate pipeline filter to only match items for which the value of the specified field contains the specified value. contains() is not case-sensitive, so the value sunday is considered to contain the value Sun.

You can use contains() with a field of type string or reference. For fields of type reference, contains() matches by the ID of the referenced item as a string. To match by other data types, use the eq() method.

Method Declaration
Copy
Method Parameters
fieldstringRequired

Field whose value is matched with the specified value.


valuestringRequired

Value to locate in the specified field.

Returns
Return Type:FilterStage
Errors

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

Did this help?