Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

@awaitjs/express

0.1.4 • Public • Published

@awaitjs/express

Write Express middleware and route handlers using async/await

Usage

const { decorateApp } = require('@awaitjs/express');
 
// Or, if you want to use `wrap()`
const { wrap } = require('@awaitjs/express');

API

decorateApp()

The decorateApp() function is the preferred way to add async/await support to your Express app. This function adds several helper functions to your Express app.

It adds useAsync(), getAsync(), etc. to your Express app

The decorateApp() function adds useAsync(), getAsync(), patchAsync(), putAsync(), postAsync(), deleteAsync() and headAsync().

const express = require('express');
const app = decorateApp(express());
 
// `useAsync()` is like `app.use()`, but supports async functions
app.useAsync(async function(req, res, next) {
  await new Promise(resolve => setTimeout(resolve, 50));
});
 
// `getAsync()` is like `app.get()`, but supports async functions
app.getAsync('*', async function(req, res, next) {
  throw new Error('Oops!');
});
 
// Because of `getAsync()`, this error handling middleware will run.
// `decorateApp()` also enables async error handling middleware.
app.use(function(error, req, res, next) {
  res.send(error.message);
});
 
const server = await app.listen(3000);

wrap()

If you need more fine-grained control than what decorateApp() gives you, you can use the wrap() function. This function wraps an async Express middleware or route handler for better error handling.

It wraps an async function with Express-compatible error handling

const express = require('express');
const app = express();
 
// `wrap()` takes an async middleware or route handler and adds a
// `.catch()` to handle any errors. It also prevents double-calling
// `next()`.
app.get('*', wrap(async function(req, res, next) {
  throw new Error('Oops!');
}));
 
// `wrap()` also supports async error handling middleware.
app.use(wrap(async function(error, req, res, next) {
  throw new Error('foo');
}));
 
app.use(function(error, req, res, next) {
  res.send(error.message); // Will send back 'foo'
});
 
const server = await app.listen(3000);

Keywords

none

install

npm i @awaitjs/express

Downloadsweekly downloads

94

version

0.1.4

license

Apache 2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability