On this page

ResponseErrorOptions

ResponseErrorOptions class

Represents the options for the ResponseError class instantiation

Constructor

new ResponseErrorOptions(optionsopt, fallbackCodeopt, fallbackMessageopt)

ResponseErrorOptions constructor

Parameters:

Name	Type	Attributes	Default	Description
`options`	Options \| object \| string	<optional>	{}	Error options or error message
`fallbackCode`	number \| string	<optional>	500	Fallback error code. Used if it is not exists in options, or it could not be converted in a number
`fallbackMessage`	string	<optional>	'Internal Server Error'	Fallback error message. Used if it is not exists in options, or it is not a string.

Source: response-error-options.js, line 32

Members

code

Get the code

Source: response-error-options.js, line 120

details

Get the details

Source: response-error-options.js, line 147

message

Get the message

Source: response-error-options.js, line 129

options

Get the options

Source: response-error-options.js, line 111

requestId

Get the request id

Source: response-error-options.js, line 138

Methods

reset() → {ResponseErrorOptions}

Reset the options to the default values

Source: response-error-options.js, line 165

Returns:

Type:: ResponseErrorOptions

toJSON() → {Options}

Plain object representation of the options

Source: response-error-options.js, line 156

Returns:

Type:: Options

(static) defaultOptions() → {Options}

Default options

Source: response-error-options.js, line 45

Returns:

Type:: Options

(static) parseCode(code, fallbacks) → {number|string}

Normalize the code and use the fallbacks if the code is empty or is not a number

Parameters:

Name	Type	Description
`code`	string \| number	Error code
`fallbacks`	Array.<string> \| Array.<number> \| number \| string	Fallback error codes

Source: response-error-options.js, line 92

Returns:

Type:: number | string