@ones-op/node-error

Require

ONES
v3.13.31+

Install

Enter the /backend directory of the plug-in project, and execute the following command to install dependencies:

npm i @ones-op/node-error

API

clientError

throw client error

Params

Param	Description	Type	Required	Default
reason	wrong reason	string	yes	-

Example

import { clientError } from '@ones-op/node-error'

export async function testClientError() {
  throw clientError('test client error')
}

---

serverError

Throw server error error

Params

Param	Description	Type	Required	Default
reason	wrong reason	string	是	-

Example

import { serverError } from '@ones-op/node-error'

export async function testServerError() {
  throw serverError('test server error')
}

---

sdkErrorToPluginError

The error of the sdk package is converted into a plug-in registration interface error

Params

Param	Description	Type	Required	Default
abilityError	The wrong type of an sdk package	any	Yes	-

Returns

Param	Description	Type
result	Plugin error corresponding to sdk package error	PluginError

Example

import { sdkErrorToPluginError } from '@ones-op/node-error'

export async function testSdkErrorToPluginError() {
  const e = new AbilityError('error', 'errrcode', 500, 'reason')
  e.statusCode = 500
  e.reason = 'reason'
  e.level = 'level'
  e.errcode = 'errcode'
  const pluginError = sdkErrorToPluginError(e)
  throw pluginError
}

Type

PluginError

Param	Description	Type
type	error level	PluginErrorTypeEnum
reason	wrong reason	string
statusCode	Corresponding http status code	string
errcode	error code	string

Enum

PluginErrorTypeEnum

pluginError error level

Enum	Description
PluginErrorTypeEnum.error	error level
PluginErrorTypeEnum.warning	warning level

CommonReason

pluginError common error reason

Enum	Text
CommonReason.RequestTimeOut	Request time out.
CommonReason.ServiceUnresponsive	Service unresponsive.
CommonReason.ServiceIsNotAvailable	Service is not available.
CommonReason.InvalidParameter	Invalid parameter.
CommonReason.NetworkError	Network error.