appendToArray( )

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 append the specified value to the specified array field.

Method Declaration
Copy
Method Parameters
fieldNamestringRequired
valueanyRequired

Value to append to the specified array 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?

incrementField( )

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 increment the specified field by the specified value.

Method Declaration
Copy
Method Parameters
fieldNamestringRequired
bynumberRequired

Value by which to increment the specified field. You can specify positive or negative values.

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?

removeField( )

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 clear the specified field.

Method Declaration
Copy
Method Parameters
fieldNamestringRequired
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?

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 specified value from the specified array field.

Method Declaration
Copy
Method Parameters
fieldNamestringRequired
valueanyRequired

Value to remove from the specified array 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?

run( )

Developer Preview

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

Runs the patch operation and returns the patched item.

The run() method returns a Promise that resolves to the patched item and item metadata.

Method Declaration
Copy
Method Parameters
optionsWixDataPatchOptions
Returns
Return Type:Promise<WixDataItem>
Errors

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

Did this help?

setField( )

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 set the specified field to the specified value.

Method Declaration
Copy
Method Parameters
fieldNamestringRequired
valueanyRequired

Value to set for the specified 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?