src/modules/http/entities/error/http-error-base.entity.intf.ts
The StarkHttpErrorBase class contains all the basic information about the error(s) that are part of the Http error in case of failure of any type of request performed by the StarkHttpService.
Properties |
| instance |
instance:
|
Type : string
|
| Optional |
|
Identifies the specific occurrence of the problem. |
| metadata |
metadata:
|
Type : object
|
| Optional |
|
Provides additional error metadata. |
| timestamp |
timestamp:
|
Type : string
|
| Optional |
|
Provides a timestamp for the error message. |
| title |
title:
|
Type : string
|
|
Short human-readable summary of the problem type. |
| titleKey |
titleKey:
|
Type : string
|
|
A message key for the summary of the problem type. |
| titleKeyParameters |
titleKeyParameters:
|
Type : string[]
|
| Optional |
|
An array of strings, each string being the value of a parameter in the titleKey |
| type |
type:
|
Type : string
|
|
The absolute URI that identifies the problem type. |
import { StarkError } from "../../../../common/error";
/**
* The StarkHttpErrorBase class contains all the basic information about the error(s) that are part of the Http
* error in case of failure of any type of request performed by the {@link StarkHttpService}.
*/
export interface StarkHttpErrorBase extends StarkError {
/**
* The absolute URI that identifies the problem type.
*/
type: string;
/**
* Short human-readable summary of the problem type.
*/
title: string;
/**
* A message key for the summary of the problem type.
*/
titleKey: string;
/**
* An array of strings, each string being the value of a parameter in the titleKey
*/
titleKeyParameters?: string[];
/**
* Identifies the specific occurrence of the problem.
*/
instance?: string;
/**
* Provides a timestamp for the error message.
*/
timestamp?: string;
/**
* Provides additional error metadata.
*/
metadata?: object;
}