Class HTTPError

A type of error to be used on HTTP requests. This is the most common type of error used by Jimpex.

Hierarchy (View Summary)

AppError
- HTTPError

Index

Constructors

Properties

_context _date _statuses

Accessors

context date response status

Methods

_parseContext getResponse

Constructors

constructor

new HTTPError(
    message: string,
    status?: string | number,
    context?: AppErrorContext,
    statuses?: Statuses,
): HTTPError
Parameters
- message: string
  The error message.
- status: string | number = ...
  The HTTP status code.
- context: AppErrorContext = {}
  Context information related to the error.
- statuses: Statuses = statusesFn
  A reference to the service that generates HTTP status codes. This is in case the implementation wants to use a special version from the container; otherwise, it will use the statuses library directly.
Returns HTTPError
Overrides AppError.constructor
- Defined in src/services/common/httpError.ts:20

Properties

`Readonly`_context

_context: AppErrorContext

The context information that can be provided to the error, and picked by the error handler.

`Readonly`_date

_date: Date

The date of when the error was generated.

`Protected`_statuses

_statuses: Statuses

The service that generates HTTP status codes.

Accessors

context

get context(): unknown
Context information related to the error.

Returns unknown
Inherited from AppError.context
- Defined in src/services/common/appError.ts:88

date

get date(): Date
The date of when the error was generated.

Returns Date
Inherited from AppError.date
- Defined in src/services/common/appError.ts:94

response

get response(): unknown
Information about the error that can be included in a response. This is set using the response key in the context option.

Returns unknown
Inherited from AppError.response
- Defined in src/services/common/appError.ts:75

status

get status(): number | undefined
An HTTP status code related to the error. This is set using the status key on the context.

Returns number | undefined
Inherited from AppError.status
- Defined in src/services/common/appError.ts:82

Methods

`Protected`_parseContext

_parseContext(context: AppErrorContext): AppErrorContext
Utility method that formats the context before saving it in the instance:
- If the context includes a status as a string, it will try to replace it with its actual status code from the statuses service.
Parameters
- context: AppErrorContext
  The original context sent to the constructor.
Returns AppErrorContext
Inherited from AppError._parseContext
- Defined in src/services/common/appError.ts:104

getResponse

getResponse<T>(): T
Gets an object that can be included in a response from the application. This method is a helper for the response getter, as it allows for the assertion of the response type.
Type Parameters
- T
  The type of the response.
Returns T
Inherited from AppError.getResponse
- Defined in src/services/common/appError.ts:68