@greguintow/catch-decorator

中文文档
1.0.5发布于 2023/10/25MITTypeScriptCommonJS零依赖近 30 天下载 1.5万

Handle exceptions by just annotating a method or class with a decorator. Based on enkot/catch-decorator.

原始使用文档
文档目录3 节
  1. Install
  2. Usage
  3. License

Catch Decorator

npm npm bundle size NPM

ECMAScript/TypeScript Catch decorator for classes and functions. Based on @enkot/catch-decorator.

Install

npm install @magna_shogun/catch-decorator

yarn add @magna_shogun/catch-decorator

Usage

catch-decorator works with any ECMAScript/TypeScript class. If you use Babel, babel-plugin-transform-decorators-legacy is needed. If you use TypeScript, enable --experimentalDecorators flag.

Catch

Decorate a function to catch the specific type of error.

class Messenger {
  @Catch(ReferenceError, (err, ctx) => {...})
  getMessages() {
    throw new ReferenceError('ReferenceError here!');
    ...
  }
}

You can stack decorators to catch and handle different types of error.

class Messenger {
  @Catch(TypeError, (err, ctx) => {...})
  @Catch(ReferenceError, (err, ctx) => {...})
  getMessages() {
    if (conditionA) {
      throw new ReferenceError('ReferenceError here!');
      ...
    }
    if (conditionB) {
      throw new TypeError('TypeError here!');
      ...
    }   
  }
}

It also works for async functions.

class Messenger {
  @Catch(ServerError, (err, ctx) => {...})
  async getMessages() {
    return fetch(myRequest).then(response => { // can throw ServerError
      ...
    });
  }
}

CatchAll

You can catch any type of errors using the CatchAll decorator.

class Messenger {
  @CatchAll((err, ctx) => {...})
  getMessages() {
    // Both ReferenceError and TypeError will be catched
    if (conditionA) {
      throw new ReferenceError('ReferenceError here!');
      ...
    }
    if (conditionB) {
      throw new TypeError('TypeError here!');
      ...
    }   
  }
}

Class Decoration

If you want to apply the same decorator to all the functions of a class (excluding its constructor), you can add the decorator to the class.

class Messenger {
  @Catch(ReferenceError, (err, ctx) => {...})
  getMessages() {
    throw new ReferenceError('ReferenceError here!');
    ...
  }
  
  @Catch(ReferenceError, (err, ctx) => {...})
  getPosts() {
    throw new ReferenceError('ReferenceError here!');
    ...
  }
}

This can be re-written as follows.

@Catch(ReferenceError, (err, ctx) => {...})
class Messenger {
  getMessages() {
    throw new ReferenceError('ReferenceError here!');
    ...
  }
  
  getPosts() {
    throw new ReferenceError('ReferenceError here!');
    ...
  }
}

HandlerFunction

The callback for the Catch and CatchAll decorators is of type HandlerFunction.

type HandlerFunction = (error: Error, ctx: any) => void;

error is the caught error or exception.
ctx is the context (this) of the function were the error was thrown.

License

MIT

版本与发布记录

@greguintow/catch-decorator 共发布 4 个版本,首次发布于 2023/10/25;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.5latest2023/10/253 年前
1.0.42023/10/253 年前
1.0.32023/10/253 年前
1.0.22023/10/253 年前

关于 @greguintow/catch-decorator 的常见问题

@greguintow/catch-decorator 是什么?

Handle exceptions by just annotating a method or class with a decorator. Based on enkot/catch-decorator.

如何安装 @greguintow/catch-decorator?

在项目目录运行 npm install @greguintow/catch-decorator,或使用 pnpm add / yarn add / bun add。

@greguintow/catch-decorator 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@greguintow/catch-decorator 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@greguintow/catch-decorator 可以商用吗?

@greguintow/catch-decorator 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@greguintow/catch-decorator 的下载量有多少?

根据 npm 官方下载统计,@greguintow/catch-decorator 在 2026/10/17 – 2026/11/15 这 30 天内被下载 15,094 次,日均约 503 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@greguintow/catch-decorator 还在维护吗?

最新版本 1.0.5 发布于 2023/10/25(3 年前);至今共发布 4 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/10/25。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。