Class: ImATeapotError

ImATeapotError

"418 I'm a teapot" response error class.

Indicates that the server refuses to brew coffee because it is, permanently, a teapot. A combined coffee/tea pot that is temporarily out of coffee should instead return 503. This error is a reference to Hyper Text Coffee Pot Control Protocol defined in April Fools' jokes in 1998 and 2014.

Some websites use this response for requests they do not wish to handle, such as automated queries.

Constructor

new ImATeapotError(dataopt)

ImATeapotError constructor

Parameters:

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

Source: im-a-teapot-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"}}