method-override

What is method-override?

The method-override npm package allows you to use HTTP verbs such as PUT or DELETE in places where the client doesn't support it. This is particularly useful for working with forms in web applications, as HTML forms only support GET and POST methods.

What are method-override's main functionalities?

Override using a query value

This feature allows you to override the HTTP method using a query parameter. For example, a POST request to /resource?_method=PUT will be treated as a PUT request.

const express = require('express');
const methodOverride = require('method-override');
const app = express();

// override with the X-HTTP-Method-Override header in the request
app.use(methodOverride('_method'));

app.post('/resource', (req, res) => {
  res.send('POST request to the resource');
});

app.put('/resource', (req, res) => {
  res.send('PUT request to the resource');
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Override using a header

This feature allows you to override the HTTP method using a custom header. For example, a POST request with the header X-HTTP-Method-Override: PUT will be treated as a PUT request.

const express = require('express');
const methodOverride = require('method-override');
const app = express();

// override with the X-HTTP-Method-Override header in the request
app.use(methodOverride('X-HTTP-Method-Override'));

app.post('/resource', (req, res) => {
  res.send('POST request to the resource');
});

app.put('/resource', (req, res) => {
  res.send('PUT request to the resource');
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Override using a function

This feature allows you to override the HTTP method using a custom function. The function can inspect the request and determine the method to override.

const express = require('express');
const methodOverride = require('method-override');
const app = express();

// override with a function
app.use(methodOverride((req, res) => {
  if (req.body && typeof req.body === 'object' && '_method' in req.body) {
    // look in urlencoded POST bodies and delete it
    const method = req.body._method;
    delete req.body._method;
    return method;
  }
}));

app.post('/resource', (req, res) => {
  res.send('POST request to the resource');
});

app.put('/resource', (req, res) => {
  res.send('PUT request to the resource');
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Other packages similar to method-override

connect

The connect package is a middleware framework for Node.js, which includes a variety of middleware functions for handling HTTP requests. It provides similar functionality to method-override through its own set of middleware options, but it is more comprehensive and includes many other features.

body-parser

The body-parser package is used to parse incoming request bodies in a middleware before your handlers, available under the req.body property. While it does not directly provide method overriding, it is often used in conjunction with method-override to handle form submissions and other request bodies.

express

Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications. Express itself does not include method overriding, but it is commonly used with method-override to handle HTTP methods in web applications.

README

method-override

Lets you use HTTP verbs such as PUT or DELETE in places where the client doesn't support it.

Install

$ npm install method-override

API

NOTE It is very important that this module is used before any module that needs to know the method of the request (for example, it must be used prior to the csurf module).

methodOverride(getter, options)

Create a new middleware function to override the req.method property with a new value. This value will be pulled from the provided getter.

• getter - The getter to use to look up the overridden request method for the request. (default: X-HTTP-Method-Override)
• options.methods - The allowed methods the original request must be in to check for a method override value. (default: ['POST'])

If the found method is supported by node.js core, then req.method will be set to this value, as if it has originally been that value. The previous req.method value will be stored in req.originalMethod.

getter

This is the method of getting the override value from the request. If a function is provided, the req is passed as the first argument, the res as the second argument and the method is expected to be returned. If a string is provided, the string is used to look up the method with the following rules:

• If the string starts with X-, then it is treated as the name of a header and that header is used for the method override. If the request contains the same header multiple times, the first occurrence is used.
• All other strings are treated as a key in the URL query string.

options.methods

This allows the specification of what methods(s) the request MUST be in in order to check for the method override value. This defaults to only POST methods, which is the only method the override should arrive in. More methods may be specified here, but it may introduce security issues and cause weird behavior when requests travel through caches. This value is an array of methods in upper-case. null can be specified to allow all methods.

Examples

override using a header

To use a header to override the method, specify the header name as a string argument to the methodOverride function. To then make the call, send a POST request to a URL with the overridden method as the value of that header. This method of using a header would typically be used in conjunction with XMLHttpRequest on implementations that do not support the method you are trying to use.

var connect        = require('connect')
var methodOverride = require('method-override')

// override with the X-HTTP-Method-Override header in the request
app.use(methodOverride('X-HTTP-Method-Override'))

Example call with header override using XMLHttpRequest:

var xhr = new XMLHttpRequest()
xhr.onload = onload
xhr.open('post', '/resource', true)
xhr.setRequestHeader('X-HTTP-Method-Override', 'DELETE')
xhr.send()

function onload() {
  alert('got response: ' + this.responseText)
}

override using a query value

To use a query string value to override the method, specify the query string key as a string argument to the methodOverride function. To then make the call, send a POST request to a URL with the overridden method as the value of that query string key. This method of using a query value would typically be used in conjunction with plain HTML <form> elements when trying to support legacy browsers but still use newer methods.

var connect        = require('connect')
var methodOverride = require('method-override')

// override with POST having ?_method=DELETE
app.use(methodOverride('_method'))

Example call with query override using HTML <form>:

<form method="POST" action="/resource?_method=DELETE">
  <button type="submit">Delete resource</button>
</form>

multiple format support

var connect        = require('connect')
var methodOverride = require('method-override')

// override with different headers; last one takes precedence
app.use(methodOverride('X-HTTP-Method'))          // Microsoft
app.use(methodOverride('X-HTTP-Method-Override')) // Google/GData
app.use(methodOverride('X-Method-Override'))      // IBM

custom logic

You can implement any kind of custom logic with a function for the getter. The following implements the logic for looking in req.body that was in method-override@1:

var bodyParser     = require('body-parser')
var connect        = require('connect')
var methodOverride = require('method-override')

// NOTE: when using req.body, you must fully parse the request body
//       before you call methodOverride() in your middleware stack,
//       otherwise req.body will not be populated.
app.use(bodyParser.urlencoded())
app.use(methodOverride(function(req, res){
  if (req.body && typeof req.body === 'object' && '_method' in req.body) {
    // look in urlencoded POST bodies and delete it
    var method = req.body._method
    delete req.body._method
    return method
  }
}))

Example call with query override using HTML <form>:

<!-- enctype must be set to the type you will parse before methodOverride() -->
<form method="POST" action="/resource" enctype="application/x-www-form-urlencoded">
  <input type="hidden" name="_method" value="DELETE">
  <button type="submit">Delete resource</button>
</form>

License

MIT