@terascope/job-components / index / TSError
Class: TSError
Defined in: packages/utils/dist/src/errors.d.ts:7
A custom Error class with additional properties, like statusCode and fatalError
Extends
Error
Constructors
new TSError()
new TSError(
input,config?):TSError
Defined in: packages/utils/dist/src/errors.d.ts:32
Parameters
| Parameter | Type |
|---|---|
input | unknown |
config? | TSErrorConfig |
Returns
Overrides
Error.constructor
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
code | string | An descriptive error code that specifies the error type, this follows more node convention | packages/utils/dist/src/errors.d.ts:12 |
context | TSErrorContext | Additional context metadata | packages/utils/dist/src/errors.d.ts:30 |
fatalError | boolean | Used to indicate the an error is fatal | packages/utils/dist/src/errors.d.ts:20 |
retryable? | boolean | Used sometimes to indicate whether an error is retryable If this is not set then it is better not to assume either way | packages/utils/dist/src/errors.d.ts:26 |
statusCode | number | A HTTP status code for easy use | packages/utils/dist/src/errors.d.ts:16 |
Methods
getCause()
getCause():
any
Defined in: packages/utils/dist/src/errors.d.ts:33
Returns
any
[hasInstance]()
static[hasInstance](_instance):boolean
Defined in: packages/utils/dist/src/errors.d.ts:31
Parameters
| Parameter | Type |
|---|---|
_instance | unknown |
Returns
boolean