@codesoul-co/hypha-core / errors

• 包索引: @codesoul-co/hypha-core
• 源码: packages/core/src/errors.ts
• 导出数: 3

模块用法

用于规范化、分类或暴露错误契约。Errors 模块公开 1 类、1 函数、1 接口。

从包入口导入

import {
  FrameworkError,
  isFrameworkError,
} from '@codesoul-co/hypha-core';

import type {
  FrameworkErrorInit,
} from '@codesoul-co/hypha-core';

使用要点

• 1 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
• 1 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。
• 1 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。

公共导出

Symbol	种类	签名	说明
FrameworkError	类	new FrameworkError(init: FrameworkErrorInit): FrameworkError	Framework Error 类，共公开 10 个构造函数或成员；精确签名见本条目的声明与成员表。
isFrameworkError	函数	isFrameworkError(error: unknown): error is FrameworkError	Is Framework Error 函数，提供 1 个公开调用签名；参数与返回类型见下表。
FrameworkErrorInit	接口	interface FrameworkErrorInit	Framework Error Init 接口，共包含 4 个公开字段或方法。

FrameworkError

Framework Error 类，共公开 10 个构造函数或成员；精确签名见本条目的声明与成员表。

• 种类: 类
• 导入: import { FrameworkError } from '@codesoul-co/hypha-core';
• 源码模块: errors

声明

export declare class FrameworkError extends Error {
    readonly code: string;
    readonly context?: Record<string, unknown>;
    readonly cause?: unknown;
    constructor(init: FrameworkErrorInit);
}

公开成员

成员	种类	签名	说明
cause	属性	readonly cause?: unknown	公开属性；类型、只读和可选状态以签名列为准。
code	属性	readonly code: string	公开属性；类型、只读和可选状态以签名列为准。
constructor	构造函数	(init: FrameworkErrorInit): FrameworkError	创建该类的实例。
context	属性	readonly context?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
message	属性	message: string	公开属性；类型、只读和可选状态以签名列为准。
name	属性	name: string	公开属性；类型、只读和可选状态以签名列为准。
stack	属性	stack?: string	公开属性；类型、只读和可选状态以签名列为准。
static captureStackTrace	方法	static captureStackTrace(targetObject: object, constructorOpt?: Function): 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. js 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: js 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();
static prepareStackTrace	方法	static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any	公开方法；参数与返回类型以签名列为准。
static stackTraceLimit	属性	static stackTraceLimit: 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.

isFrameworkError

Is Framework Error 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { isFrameworkError } from '@codesoul-co/hypha-core';
• 源码模块: errors

声明

export declare function isFrameworkError(error: unknown): error is FrameworkError;

调用签名

isFrameworkError(error: unknown): error is FrameworkError

参数

参数	类型	必需	说明
error	unknown	是	必需参数；接受的值由类型列定义。

返回值

• 类型: error is FrameworkError
• 说明: 返回值契约由上述类型定义。

FrameworkErrorInit

Framework Error Init 接口，共包含 4 个公开字段或方法。

• 种类: 接口
• 导入: import type { FrameworkErrorInit } from '@codesoul-co/hypha-core';
• 源码模块: errors

声明

export interface FrameworkErrorInit {
    code: string;
    message: string;
    context?: Record<string, unknown>;
    cause?: unknown;
}

契约成员

成员	种类	签名	说明
cause	属性	cause?: unknown	公开属性；类型、只读和可选状态以签名列为准。
code	属性	code: string	公开属性；类型、只读和可选状态以签名列为准。
context	属性	context?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
message	属性	message: string	公开属性；类型、只读和可选状态以签名列为准。