用户
此软件包包含跨 Elementor 软件包使用的功能 .
错误
本模块包含一个用于创建元素包自定义错误类的标准 API.
createError
为了确保元素包的一致性,我们建议创建一个新的错误类,以扩展
ElementorError 使用 createError 函数可以帮助您.
创建新错误类型
为了方便 我们暴露了 createError 用于为您创建自定义错误类型的工具函数.
此函数将强制您的错误代码和消息为静态( 按我们的准则), 并会缩短您的代码 :
// errors.ts
import { createError } from '@elementor/utils';
export const CannotRender = createError<{ id: string; }>( 'cannot-render', 'Cannot render element' );
export const CannotSave = createError<{ id: number; status: string; }>( 'cannot-save', 'Cannot save document' );
export const ElementNotFound = createError<{ id: string; }>( 'element-not-found', 'Element not found' );
手动创建新错误类型
如果您更愿意手动创建新错误类型,则可以扩展 ElementorError 课.
在你的班级内,你需要定义一个独特的错误代码和消息,这些代码和消息应该传递给母建构者.
我们建议给代码和信件都设置静态字符串值,这样就更容易过滤到
错误跟踪工具(例如:. message = 'cannot render element'; 而不是说 message = 'Cannot render element' + id;) (中文(简体) ).
如果需要传递更多关于错误的信息,请在上下文中附加.
import { ElementorError, type ElementorErrorOptions } from '@elementor/utils';
type CannotRenderContext = {
id: string;
};
type CannotRenderOptions = {
context: CannotRenderContext;
cause?: ElementorErrorOptions['cause'];
};
class CannotRender extends ElementorError {
constructor( { context, cause }: CannotRenderOptions ) {
const code = 'cannot-render';
const message = 'Cannot render element';
super( message, { cause, context, code } );
}
}
丢弃您的自定义错误类型
在创建自定义错误类型( 如上所描述)后, 您可以将其丢入您的代码 :
基本实例:
export const ElementNotFound = createError<{ id: string; }>( 'element-not-found', 'Element not found' );
function renderElement( id: string ): string {
const element = findElementById( id );
if ( ! element ) {
throw new ElementNotFound({ context: { id } });
}
return element.render();
}
有原因的例子 :
export const CannotSave = createError<{ id: number; status: string; }>( 'cannot-save', 'Cannot save document' );
try {
thirdPartyService.save( id );
} catch ( error ) {
throw new CannotSave({ context: { id, status: error.status }, cause: error });
}
ensureError
这个 ensureError 函数是一个工具函数,可以确保给定值是一个错误.
如果该值已经是错误, 将按原样返回 .
如果值不是错误, 则用 Error 包括抛出值.
import { ensureError } from '@elementor/utils';
const CannotUpdate = createError<{ id: number; }>( 'cannot-update', 'Cannot update document' );
try {
thirdPartyService.update( id );
} catch ( error ) {
const errorInstance = ensureError( error );
throw new CannotUpdate({ context: { id }, cause: errorInstance });
}