@terascope/core-utils / errors
errors
Classes
| Class | Description |
|---|---|
| EstimatedElasticOpenSearchError | - |
| TSError | A custom Error class with additional properties, like statusCode and fatalError |
Interfaces
| Interface | Description |
|---|---|
| SearchErrorMetadata | - |
| TSErrorConfig | - |
| TSErrorContext | - |
Functions
formatAggregateError()
formatAggregateError(
aggregateError):Promise<void>
Defined in: packages/core-utils/src/errors.ts:553
Formats an AggregateError into a user-friendly Error which shows the first five Errors from the Aggregate.
Parameters
| Parameter | Type | Description |
|---|---|---|
aggregateError | unknown | - |
Returns
Promise<void>
getErrorStatusCode()
getErrorStatusCode(
err,config?,defaultCode?):number
Defined in: packages/core-utils/src/errors.ts:493
Parameters
| Parameter | Type | Default value |
|---|---|---|
err | unknown | undefined |
config | TSErrorConfig | {} |
defaultCode | number | DEFAULT_STATUS_CODE |
Returns
number
getFullErrorStack()
getFullErrorStack(
err):string
Defined in: packages/core-utils/src/errors.ts:163
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
getSearchErrorType()
getSearchErrorType(
err):"Elasticsearch"|"OpenSearch"|undefined
Defined in: packages/core-utils/src/errors.ts:414
Check if it's an Elasticsearch or OpenSearch error,
Parameters
| Parameter | Type |
|---|---|
err | unknown |
Returns
"Elasticsearch" | "OpenSearch" | undefined
"Elasticsearch" | "OpenSearch" | undefined
isError()
isError(
err):err is Error
Defined in: packages/core-utils/src/errors.ts:398
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/core-utils/src/errors.ts:389
Parameters
| Parameter | Type |
|---|---|
err | unknown |
Returns
boolean
isRetryableError()
isRetryableError(
err):boolean
Defined in: packages/core-utils/src/errors.ts:393
Parameters
| Parameter | Type |
|---|---|
err | unknown |
Returns
boolean
isTSError()
isTSError(
err):err is TSError
Defined in: packages/core-utils/src/errors.ts:403
Check is a TSError
Parameters
| Parameter | Type |
|---|---|
err | unknown |
Returns
err is TSError
logError()
logError(
logger,err, ...messages):void
Defined in: packages/core-utils/src/errors.ts:235
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/core-utils/src/errors.ts:273
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/core-utils/src/errors.ts:175
parse error for info
Parameters
| Parameter | Type |
|---|---|
input | unknown |
config | TSErrorConfig |
Returns
ErrorInfo
prefixErrorMsg()
prefixErrorMsg(
input,prefix?,defaultMsg?):string
Defined in: packages/core-utils/src/errors.ts:377
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/core-utils/src/errors.ts:517
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/core-utils/src/errors.ts:323
Parameters
| Parameter | Type |
|---|---|
input | string | undefined |
Returns
string