Utils: `errors`
Table of contents
Classes
Interfaces
Functions
- getErrorStatusCode
- getFullErrorStack
- isElasticsearchError
- isError
- isFatalError
- isRetryableError
- isTSError
- logError
- parseError
- parseErrorInfo
- prefixErrorMsg
- stripErrorMessage
- toStatusErrorCode
Functions
getErrorStatusCode
▸ getErrorStatusCode(err
, config?
, defaultCode?
): number
Parameters
Name | Type | Default value |
---|---|---|
err | unknown | undefined |
config | TSErrorConfig | {} |
defaultCode | number | DEFAULT_STATUS_CODE |
Returns
number
Defined in
packages/utils/src/errors.ts:428
getFullErrorStack
▸ getFullErrorStack(err
): string
Use following the chain of caused by stack of an error. Don't use this when logging the error, only when sending it
Parameters
Name | Type |
---|---|
err | unknown |
Returns
string
Defined in
packages/utils/src/errors.ts:164
isElasticsearchError
▸ isElasticsearchError(err
): err is ElasticsearchError
Check is a elasticsearch error
Parameters
Name | Type |
---|---|
err | unknown |
Returns
err is ElasticsearchError
Defined in
packages/utils/src/errors.ts:392
isError
▸ isError(err
): err is Error
Check if an input has an error compatible api
Parameters
Name | Type |
---|---|
err | unknown |
Returns
err is Error
Defined in
packages/utils/src/errors.ts:379
isFatalError
▸ isFatalError(err
): boolean
Parameters
Name | Type |
---|---|
err | unknown |
Returns
boolean
Defined in
packages/utils/src/errors.ts:370
isRetryableError
▸ isRetryableError(err
): boolean
Parameters
Name | Type |
---|---|
err | unknown |
Returns
boolean
Defined in
packages/utils/src/errors.ts:374
isTSError
▸ isTSError(err
): err is TSError
Check is a TSError
Parameters
Name | Type |
---|---|
err | unknown |
Returns
err is TSError
Defined in
packages/utils/src/errors.ts:384
logError
▸ logError(logger
, err
, ...messages
): void
Safely log an error (with the error first Logger syntax)
Parameters
Name | Type |
---|---|
logger | Logger |
err | unknown |
...messages | any [] |
Returns
void
Defined in
packages/utils/src/errors.ts:230
parseError
▸ parseError(input
, withStack?
): string
parse input to get error message or stack
Parameters
Name | Type | Default value |
---|---|---|
input | unknown | undefined |
withStack | boolean | false |
Returns
string
Defined in
packages/utils/src/errors.ts:268
parseErrorInfo
▸ parseErrorInfo(input
, config?
): ErrorInfo
parse error for info
Parameters
Name | Type |
---|---|
input | unknown |
config | TSErrorConfig |
Returns
ErrorInfo
Defined in
packages/utils/src/errors.ts:176
prefixErrorMsg
▸ prefixErrorMsg(input
, prefix?
, defaultMsg?
): string
Parameters
Name | Type | Default value |
---|---|---|
input | unknown | undefined |
prefix? | string | undefined |
defaultMsg | string | 'Unknown Error' |
Returns
string
Defined in
packages/utils/src/errors.ts:358
stripErrorMessage
▸ stripErrorMessage(error
, reason?
, requireSafe?
): string
Parameters
Name | Type | Default value |
---|---|---|
error | unknown | undefined |
reason | string | DEFAULT_ERR_MSG |
requireSafe | boolean | false |
Returns
string
Defined in
packages/utils/src/errors.ts:449
toStatusErrorCode
▸ toStatusErrorCode(input
): string
Parameters
Name | Type | |
---|---|---|
input | undefined \ | string |
Returns
string