@terascope/utils / errors
errors
Classes
| Class | Description |
|---|---|
| TSError | A custom Error class with additional properties, like statusCode and fatalError |
Interfaces
| Interface | Description |
|---|---|
| ElasticsearchError | - |
| TSErrorConfig | - |
| TSErrorContext | A simple object with any values |
Functions
getErrorStatusCode()
getErrorStatusCode(
err,config,defaultCode):number
Defined in: packages/utils/src/errors.ts:430
Parameters
| Parameter | Type | Default value |
|---|---|---|
err | unknown | undefined |
config | TSErrorConfig | {} |
defaultCode | number | DEFAULT_STATUS_CODE |
Returns
number
getFullErrorStack()
getFullErrorStack(
err):string
Defined in: packages/utils/src/errors.ts:165
Use following the chain of caused by stack of an error. Don't use this when logging the error, only when sending it
Parameters
| Parameter | Type |
|---|---|
err | unknown |
Returns
string
isElasticsearchError()
isElasticsearchError(
err):err is ElasticsearchError
Defined in: packages/utils/src/errors.ts:394
Check is a elasticsearch error
Parameters
| Parameter | Type |
|---|---|
err | unknown |
Returns
err is ElasticsearchError
isError()
isError(
err):err is Error
Defined in: packages/utils/src/errors.ts:381
Check if an input has an error compatible api
Parameters
| Parameter | Type |
|---|---|
err | unknown |
Returns
err is Error
isFatalError()
isFatalError(
err):boolean
Defined in: packages/utils/src/errors.ts:372
Parameters
| Parameter | Type |
|---|---|
err | unknown |
Returns
boolean
isRetryableError()
isRetryableError(
err):boolean
Defined in: packages/utils/src/errors.ts:376
Parameters
| Parameter | Type |
|---|---|
err | unknown |
Returns
boolean
isTSError()
isTSError(
err):err is TSError
Defined in: packages/utils/src/errors.ts:386
Check is a TSError
Parameters
| Parameter | Type |
|---|---|
err | unknown |
Returns
err is TSError
logError()
logError(
logger,err, ...messages):void
Defined in: packages/utils/src/errors.ts:232
Safely log an error (with the error first Logger syntax)
Parameters
| Parameter | Type |
|---|---|
logger | Logger |
err | unknown |
...messages | any[] |
Returns
void
parseError()
parseError(
input,withStack):string
Defined in: packages/utils/src/errors.ts:270
parse input to get error message or stack
Parameters
| Parameter | Type | Default value |
|---|---|---|
input | unknown | undefined |
withStack | boolean | false |
Returns
string
parseErrorInfo()
parseErrorInfo(
input,config):ErrorInfo
Defined in: packages/utils/src/errors.ts:177
parse error for info
Parameters
| Parameter | Type |
|---|---|
input | unknown |
config | TSErrorConfig |
Returns
ErrorInfo
prefixErrorMsg()
prefixErrorMsg(
input,prefix?,defaultMsg?):string
Defined in: packages/utils/src/errors.ts:360
Parameters
| Parameter | Type | Default value |
|---|---|---|
input | unknown | undefined |
prefix? | string | undefined |
defaultMsg? | string | 'Unknown Error' |
Returns
string
stripErrorMessage()
stripErrorMessage(
error,reason,requireSafe):string
Defined in: packages/utils/src/errors.ts:451
Parameters
| Parameter | Type | Default value |
|---|---|---|
error | unknown | undefined |
reason | string | DEFAULT_ERR_MSG |
requireSafe | boolean | false |
Returns
string
toStatusErrorCode()
toStatusErrorCode(
input):string
Defined in: packages/utils/src/errors.ts:328
Parameters
| Parameter | Type |
|---|---|
input | undefined | string |
Returns
string