zentao-api / ZentaoError

Class: ZentaoError

SDK 统一错误类型。

所有可预期错误（参数缺失、HTTP/网络/超时、登录失败、profile 异常等）都通过 ZentaoError 抛出并携带稳定 ErrorCode，方便调用方按 code 区分处理。 错误消息默认来自 ERRORS 中的模板，并支持占位符替换。

Extends

• Error

Constructors

Constructor

new ZentaoError(code, replacements?, details?): ZentaoError

构造 SDK 错误实例。

Parameters

Parameter	Type	Description
code	"E_INVALID_BASE_URL" | "E_NO_GLOBAL_CLIENT" | "E_HTTP_ERROR" | "E_NETWORK_ERROR" | "E_TIMEOUT" | "E_INSECURE_BROWSER" | "E_LOGIN_FAILED" | "E_INVALID_PROFILE" | "E_NO_PROFILE" | "E_PROFILE_NOT_FOUND" | "E_PROFILE_STORAGE_INVALID" | "E_PROFILE_STORAGE_UNAVAILABLE" | "E_INVALID_MODULE" | "E_INVALID_ACTION" | "E_INVALID_MODULE_DEFINITION" | "E_INVALID_ACTION_DEFINITION" | "E_MISSING_PARAM" | "E_INVALID_PARAM" | "E_INVALID_REQUEST_NAME" | "E_API_FAILED"	错误码，必须是 ERRORS 中已声明的 key。
replacements?	Record<string, string | number>	可选的占位符替换值；遍历后会把 {key} 替换为字符串化的值。
details?	unknown	可选的附加上下文（HTTP 响应详情、原始异常等），保存到 details。

Returns

ZentaoError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from
cause?	public	unknown	-	Error.cause
code	readonly	"E_INVALID_BASE_URL" | "E_NO_GLOBAL_CLIENT" | "E_HTTP_ERROR" | "E_NETWORK_ERROR" | "E_TIMEOUT" | "E_INSECURE_BROWSER" | "E_LOGIN_FAILED" | "E_INVALID_PROFILE" | "E_NO_PROFILE" | "E_PROFILE_NOT_FOUND" | "E_PROFILE_STORAGE_INVALID" | "E_PROFILE_STORAGE_UNAVAILABLE" | "E_INVALID_MODULE" | "E_INVALID_ACTION" | "E_INVALID_MODULE_DEFINITION" | "E_INVALID_ACTION_DEFINITION" | "E_MISSING_PARAM" | "E_INVALID_PARAM" | "E_INVALID_REQUEST_NAME" | "E_API_FAILED"	错误码，对应 ERRORS 的 key；用于稳定地区分错误类型。	-
details?	readonly	unknown	附加上下文，例如 HTTP 响应详情、原始异常或失败的禅道响应原文。	-
message	public	string	-	Error.message
name	public	string	-	Error.name
stack?	public	string	-	Error.stack
stackTraceLimit	static	number	The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)). The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace