allow-methods

Allow-Methods

Express/connect middleware to handle 405 errors, when a request method is not supported by your route or application.

Table of Contents

• Requirements
• Usage
• Contributing
• License

Requirements

This library requires the following to run:

• Node.js 14+

Usage

Install with npm:

npm install allow-methods

Load the library into your code with a require call:

const allowMethods = require('allow-methods');

allowMethods will return a middleware function that will error if the request method does not match one of the allowed methods. The error will have message and status properties which you can use.

It accepts two arguments. Firstly, an array of allowed methods:

allowMethods(['get', 'head', 'post']);

Secondly (optionally) a message which will be used in the error if the request message does not match:

allowMethods(['get', 'head'], 'Unsupported method');

Route-level

const express = require('express');
const app = express();

app
    .route('/example')
    // Only requests with a GET/HEAD method will continue
    .all(allowMethods(['get', 'head']))
    // Define GET handler
    .get(function () { ... });

If you want to do something useful with the error, for example output a sensible JSON response, you will need to define an error handler for your application (after the route definition):

app.use(function (error, requst, response, next) {
    response.status(error.status || 500).send({
        message: error.message
    });
});

Application-level

const express = require('express');
const app = express();

// Only allow GET/HEAD methods across the entire application
app.use(allowMethods(['get', 'head']));

Contributing

The contributing guide is available here. All contributors must follow this library's code of conduct.

License

Licensed under the MIT license.
Copyright © 2015, Rowan Manning

Changelog

4.0.1 (2022-05-26)

Documentation Changes

• manually define changelog sections (31e0c71)

Miscellaneous

• bump @commitlint/cli from 16.2.4 to 17.0.0 (46019dc)
• bump @commitlint/cli from 17.0.0 to 17.0.1 (a262c31)
• bump @commitlint/config-conventional from 16.2.4 to 17.0.0 (4eb1105)
• bump @rowanmanning/eslint-config from 3.4.0 to 3.5.0 (f75542e)
• bump eslint from 8.14.0 to 8.15.0 (fc4a8d8)
• bump eslint from 8.15.0 to 8.16.0 (6efa7c0)
• bump husky from 7.0.4 to 8.0.1 (5c610f6)
• bump mocha from 9.2.2 to 10.0.0 (ecc9a97)