Class: ResponseError

Constructor

new ResponseError(data)

ResponseError constructor

Parameters:

Name	Type	Description
`data`	Object \| String \| ResponseErrorOptions \| Options

Properties

Name	Type	Description
`message`	String	Error message
`code`	String \| Number	Error code
`requestId`	String	Request ID
`details`	String \| *	Error details

Source: response-error.js, line 14

Members

status

Error status

Source: response-error.js, line 58

Examples

404 Not Found

451 Unavailable For Legal Reasons

500 Internal Server Error

Methods

toJSON() → {Object}

Plain object representation of the error

Source: response-error.js, line 105

Returns:

Type:: Object

Example

// returned JSON
{
  error: {
    code: 400,
    requestId: '123456-test-request-id',
    message: 'Baaaaaad Request :-(',
    details: 'Check your request body'
  }
}

toPojo() → {Object}

Plain object representation of the error

Source: response-error.js, line 78

Returns:

Type:: Object

Example

// returned object
{
  error: {
    code: 400,
    requestId: '123456-test-request-id',
    message: 'Baaaaaad Request :-(',
    details: 'Check your request body'
  }
}

toString() → {string}

String representation of the error

Source: response-error.js, line 118

Returns:

Type:: string

Example

// returned string
{"error":{"code":400,"requestId":"123456-test-request-id","message":"Baaaaaad Request :-(","details":"Check your request body"}}