UNPKG

1.14 kBTypeScriptView Raw
1/** @module errors */
2/**
3 * Serializeable error description. It is use to pass information about errors
4 * between microservices implemented in different languages. On the receiving side
5 * [[ErrorDescription]] is used to recreate exception object close to its original type
6 * without missing additional details.
7 *
8 * @see [[ApplicationException]]
9 * @see [[ApplicationExceptionFactory]]
10 */
11export declare class ErrorDescription {
12 /** Data type of the original error */
13 type: string;
14 /** Standard error category */
15 category: string;
16 /** HTTP status code associated with this error type */
17 status: number;
18 /** A unique error code */
19 code: string;
20 /** A human-readable error description (usually written in English) */
21 message: string;
22 /** A map with additional details that can be used to restore error description in other languages */
23 details: any;
24 /** A unique transaction id to trace execution throug call chain */
25 correlation_id: string;
26 /** Original error wrapped by this exception */
27 cause: string;
28 /** Stack trace of the exception */
29 stack_trace: string;
30}