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
function removeField(field: string): WixDataPatch;
Method Parameters
fieldstringRequired

Field whose value is cleared. Nested fields can be specified using dot notation. For example: address.street.

Returns
Return Type:WixDataPatch
Remove field
JavaScript
import { items } from "@wix/data";

async function removeField() {
  const updatedItem = await items
    .patch("BlogPosts", "fb071093-9a40-432d-ae1f-2e5966fecbfa")
    .removeField("oldField")
    .run();

  const id = updatedItem._id; // "fb071093-9a40-432d-ae1f-2e5966fecbfa"
  const viewCount = updatedItem.oldField; // undefined
}
Errors

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

Did this help?