Class: ContentTooLargeError

ContentTooLargeError

"413 Content Too Large" response error class.

Indicates that the request entity is larger than limits defined by server; the server might close the connection or return a Retry-After header field.

Prior to RFC 9110 the response phrase for the status was Payload Too Large. That name is still widely used.

Constructor

new ContentTooLargeError(dataopt)

ContentTooLargeError constructor

Parameters:

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

Source: content-too-large-error.js, line 18

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"}}