TDXApiError

The TDX api supplies detailed error information depending on the context of the call. In some instances, e.g. attempting to retrieve a resource that does not exist, the error will be a simple NotFound string message. In other cases, e.g. attempting to update 100 documents in a single call, the error will supply details for each document update that failed, such as the primary key of the document and the reason for the failure.

Constructor

new TDXApiError()

Source:

api-tdx-error.js, line 37

Examples

`failure` for simple query error

const failure = {
  code: "NotFound",
  message: "resource not found: KDiEI3k_"
};

`failure` for complex data update error

const failure = {
 code: "BadRequestError",
 message: [
   {
     key: {id: "foo"},
     error: {
       message: "document not found matching key 'foo'"
     }
   },
   {
     key: {id: "bar"},
     error: {
       message: "'hello' is not a valid enum value",
       name: "ValidatorError",
       kind: "enum"
       path: "value"
     }
   }
 ]
};