TypeScript中的自定义错误类

Question

我想在TypeScript中创建自己的错误类,扩展核心Error以提供更好的错误处理和自定义报告.例如,我想创建一个HttpRequestError带有url,response和body的类传递给它的构造函数,该函数响应Http请求到http://example.com失败,状态代码为500,并显示消息:出错并且堆栈跟踪正确.

如何在TypeScript中扩展核心Error类？我已经在SO中找到了帖子:如何在TypeScript中扩展宿主对象(例如,错误),但这个解决方案对我不起作用.我使用TypeScript 1.5.3

有任何想法吗？

Answer 1

TypeScript 2.1在扩展内置插件(如Error)方面有重大变化.

从TypeScript中断更改文档

class FooError extends Error {
    constructor(m: string) {
        super(m);

        // Set the prototype explicitly.
        Object.setPrototypeOf(this, FooError.prototype);
    }

    sayHello() {
        return "hello " + this.message;
    }
}

然后你可以使用:

let error = new FooError("msg");
if(error instanceof FooError){
   console.log(error.sayHello();
}

Answer 2

直到1.6滚动,我才刚刚开始自己​​的可扩展课程.

class BaseError {
    constructor () {
        Error.apply(this, arguments);
    }
}

BaseError.prototype = new Error();

class HttpRequestError extends BaseError {
    constructor (public status: number, public message: string) {
        super();    
    }
}

var error = new HttpRequestError(500, 'Server Error');

console.log(
    error,
    // True
    error instanceof HttpRequestError,
    // True
    error instanceof Error
);

Answer 3

对于 Typescript 3.7.5，此代码提供了一个自定义错误类，该类也捕获了正确的堆栈信息。注意instanceof不起作用，所以我name改用

// based on https://gunargessner.com/subclassing-exception

// example usage
try {
  throw new DataError('Boom')
} catch(error) {
  console.log(error.name === 'DataError') // true
  console.log(error instanceof DataError) // false
  console.log(error instanceof Error) // true
}

class DataError {
  constructor(message: string) {
    const error = Error(message);

    // set immutable object properties
    Object.defineProperty(error, 'message', {
      get() {
        return message;
      }
    });
    Object.defineProperty(error, 'name', {
      get() {
        return 'DataError';
      }
    });
    // capture where error occured
    Error.captureStackTrace(error, DataError);
    return error;
  }
}

还有一些其他的选择和原因的讨论。

Answer 4

我正在使用TypeScript 1.8,这就是我使用自定义错误类的方法:

UnexpectedInput.ts

class UnexpectedInput extends Error {

  public static UNSUPPORTED_TYPE: string = "Please provide a 'String', 'Uint8Array' or 'Array'.";

  constructor(public message?: string) {
    super(message);
    this.name = "UnexpectedInput";
    this.stack = (<any> new Error()).stack;
  }

}

export default UnexpectedInput;

MyApp.ts

import UnexpectedInput from "./UnexpectedInput";

...

throw new UnexpectedInput(UnexpectedInput.UNSUPPORTED_TYPE);

对于早于1.8的TypeScript版本,您需要声明Error:

export declare class Error {
  public message: string;
  public name: string;
  public stack: string;
  constructor(message?: string);
}

Answer 5

这在当前最新版本的 typescript (4.7.3) 中似乎不是问题：

import { expect } from 'chai';
import { describe } from 'mocha';

class MyError extends Error {}

describe('Custom error class "MyError"', () => {
  it('should be an instance of "MyError"', () => {
    try {
      throw new MyError();
    } catch (e) {
      expect(e).to.be.an.instanceOf(MyError);
    }
  });
});

我不确定哪个版本改变了行为，但此测试在 2.1 上失败。

Answer 6

在https://www.npmjs.com/package/ts-custom-error有一个简洁的库

ts-custom-error 允许您非常轻松地创建错误自定义错误：

import { CustomError } from 'ts-custom-error'
 
class HttpError extends CustomError {
    public constructor(
        public code: number,
        message?: string,
    ) {
        super(message)
    }
}

用法：

new HttpError(404, 'Not found')