Class: PreconditionFailedError

PreconditionFailedError

"412 Precondition Failed" response error class.

Indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET or HEAD when the condition defined by the If-Unmodified-Since or If-None-Match headers is not fulfilled. In that case, the request, usually an upload or a modification of a resource, cannot be made and this error response is sent back.

Constructor

new PreconditionFailedError(dataopt)

PreconditionFailedError constructor

Parameters:

Name	Type	Attributes	Description
`data`	Object \| String \| ResponseErrorOptions \| Options \| undefined	<optional>	Error message or options

Source: precondition-failed-error.js, line 19

Extends

ResponseError

Members

status

Error status

Overrides: ResponseError#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

Overrides: ResponseError#toJSON
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

Overrides: ResponseError#toPojo
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

Overrides: ResponseError#toString
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"}}