Have ideas to improve npm?Join in the discussion! »

    express-safe-async
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    logo

    Version travis Documentation Maintenance License: MIT

    Elegant async error handler with Decorator for async router function(controller) in express

    If you use async method for route handler and middleware, There must be some problem. When some error occured in async method, express can't handle your errors. So you should deal with it yourself. It is a pretty annoying task to handle this.

    This library provides a simple and elegant decorator @AsyncHandled to handle these errors from async method. this decorator handles occured errors from async method and bind this automatically.

    Nothing needs your attention anymore.
    

    🏠 Homepage

    Install

    Highly Recommend to use higher version than v2.0.1, If you are using lower version, You should update it.

    npm install express-safe-async

    Import

    TypeScript

    import AsyncHandled, { safe } from 'express-safe-async';

    JavaScript

    const safe = require('express-safe-async').safe;

    Usage

    To use Decorator, Make sure the below line is in your tsconfig.json

    tsconfig.json

    {
        "compilerOptions": {
            "target": "ES5",
            "experimentalDecorators": true
        }
    }

    or

    tsc --target ES5 --experimentalDecorators

    Using Class Method

    Just write @AsyncHandled on your async methods.

    import * as express from 'express';
    import AsyncHandled from 'express-safe-async';
     
    class ExampleController {
      @AsyncHandled // <- This is all you should do.
      public async asyncMethod(req: express.Request, res: express.Response) {
        // Your stuff here
        ...
      }
    }
     
    const app = express();
    const example = new ExampleController();
     
    app.get('/example', example.asyncMethod);
    app.listen(PORT, (err) => {
      ...
    });

    Not Using Class Method

    Wrap your functions with safe() like below.

    import * as express from 'express';
    import { safe } from 'express-safe-async';
     
    const app = express();
     
    app.use(safe( // <- This is all you should do
      async () => {
        // Your middleware here
        ...
      }
    ));
     
    app.get('/example', safe( // <- This is all you should do
      async (req: express.Request, res: express.Response) => {
        // Your route handler here
        ...
      }
    ));
     
    app.listen(1234, (err) => {
      ...
    });

    Run tests when you contribute

    npm run test

    Author

    👤 Yunbin Chang

    🤝 Contributing

    Contributions, issues and feature requests are welcome!
    Feel free to check issues page. You can also take a look at the contributing guide.

    Show your support

    Give a ⭐️ if this project helped you!

    📝 License

    Copyright © 2020 Yunbin Chang.
    This project is MIT licensed.

    Install

    npm i express-safe-async

    DownloadsWeekly Downloads

    11

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    16.5 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar