removeFromArray( )


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 patch operation to remove the first instance of the specified value from the specified array or multi-reference field.

Method Declaration
Copy
Method Parameters
fieldstringRequired

Array or multi-reference field to remove the specified value from. Nested fields can be specified using dot notation. For example: address.street.


valueanyRequired

Value whose first instance is removed from the specified array or multi-reference field.

Returns
Return Type:WixDataPatch
Errors

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

Did this help?