Skip to content

constructor ​

Signature ​

constructor(responseData, response, options)

Parameters ​

NameTypeRequiredDescription
responseDataanyyesThe decoded 409 body: { confirmation_required, digest, warnings }.
responseResponseyesThe response object associated with the error.
optionsobjectno

options Properties ​

NameTypeRequiredDefaultDescription
bulkbooleanWhether messages uses the per-object {object_id: {field: [messages]}} shape (true) or the aggregate {field: [messages]} shape (false). The server chooses this shape by request path, not by how many objects the request affects. The caller that issued the request is the only place that knows which path it took, so it must supply this option; it cannot be recovered from responseData alone.

Returns ​

ConfirmationRequiredError

Source ​

client/lib/utils/errors.js:266