Class ErrorService

The base service that handles any errors.

Hierarchy

ErrorService

Implements

IErrorHandler

Index

Constructors

Properties

DEFAULT_ERROR_MESSAGE

Methods

createApiError createHttpError getApiErrorMessage getAxiosResponse getErrorCode getHttpErrorMessage handle handleApiError handleHttpError handleTimeoutError

Constructors

constructor

new ErrorService(): ErrorService
Returns ErrorService

Properties

`Static` `Protected` `Readonly` DEFAULT_ERROR_MESSAGE

DEFAULT_ERROR_MESSAGE: "Unknown error" = 'Unknown error'

Error message used when the specific error type is not defined in the required enums.

Methods

`Protected` createApiError

createApiError(errorCode): ApiError
Creates an API error instance based on the provided error code.
Parameters
- errorCode: number
  
  The error code.
Returns ApiError
An API error instance.
- Defined in src/services/internal/ErrorService.ts:141

`Protected` createHttpError

createHttpError(httpStatus): HttpError
Creates an HTTP error instance based on the provided HTTP status.
Parameters
- httpStatus: number
  
  The HTTP status code.
Returns HttpError
An HTTP error instance.
- Defined in src/services/internal/ErrorService.ts:107

`Protected` getApiErrorMessage

getApiErrorMessage(errorCode): string
Retrieves the API error message based on the provided error code.
Parameters
- errorCode: number
  
  The error code.
Returns string
The API error message.
- Defined in src/services/internal/ErrorService.ts:151

`Protected` getAxiosResponse

getAxiosResponse(error): AxiosResponse<any, any>
Retrieves the response data from the given error.
Parameters
- error: AxiosError<unknown, any>
  
  The error object.
Returns AxiosResponse<any, any>
The response data.

Throws
The original error if it is not an HTTP error with a response.
- Defined in src/services/internal/ErrorService.ts:67

`Protected` getErrorCode

getErrorCode(response): undefined | number
Retrieves the API error code from the Axios response data.
Parameters
- response: AxiosResponse<any, any>
  
  The response object received.
Returns undefined | number
The error code, or undefined if not found.
- Defined in src/services/internal/ErrorService.ts:129

`Protected` getHttpErrorMessage

getHttpErrorMessage(httpStatus): string
Retrieves the HTTP error message based on the provided HTTP status.
Parameters
- httpStatus: number
  
  The HTTP status code.
Returns string
The HTTP error message.
- Defined in src/services/internal/ErrorService.ts:117

handle

handle(error): void
The method called when an error response is received from Twitter API.
Parameters
- error: unknown
  
  The error caught while making HTTP request to Twitter API.
Returns void
Implementation of IErrorHandler.handle
- Defined in src/services/internal/ErrorService.ts:36

`Protected` handleApiError

handleApiError(response): void
Handles API error in a response.
Parameters
- response: AxiosResponse<any, any>
  
  The response object received.
Returns void

Throws
An error with the corresponding API error message if any API-related error has occurred.
- Defined in src/services/internal/ErrorService.ts:91

`Protected` handleHttpError

handleHttpError(response): void
Handles HTTP error in a response.
Parameters
- response: AxiosResponse<any, any>
  
  The response object received.
Returns void

Throws
An error with the corresponding HTTP status text if any HTTP-related error has occurred.
- Defined in src/services/internal/ErrorService.ts:81

`Protected` handleTimeoutError

handleTimeoutError(error): void
Handles exceeded timeout, configured in RettiwtConfig.
Parameters
- error: AxiosError<unknown, any>
  
  The error object.
Returns void

Throws
An error if the configured request timeout has been exceeded.
- Defined in src/services/internal/ErrorService.ts:54

Generated using TypeDoc