Headers.delete()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for the proper prefixes to use in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the spec changes.

The delete() method of the Headers interface deletes a header from the current Headers object.

This method throws a TypeError for the following reasons:

  • The value of the name parameter is not the name of an HTTP header.
  • The value of Guard is immutable.

For security reasons, some headers can only be controller by the user agent. These headers include the forbidden header names  and forbidden response header names.

Syntax

JavaScript
myHeaders.delete(name);

Parameters

name
The name of the HTTP header you want to delete from the Headers object.

Returns

Void.

Example

Creating an empty Headers object is simple:

JavaScript
var myHeaders = new Headers(); // Currently empty

You could add a header to this using Headers.append:

JavaScript
myHeaders.append('Content-Type', 'image/jpeg');
myHeaders.get('Content-Type'); // Returns 'image/jpeg'

You can then delete it again:

JavaScript
myHeaders.delete('Content-Type');
myHeaders.get('Content-Type'); // Returns null, as it has been deleted

Specifications

Specification Status Comment
Fetch
The definition of 'delete()' in that specification.
Living Standard  

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 42
41 behind pref
 
39 (39)
34 behind pref
Not supported

29
28 behind pref

Not supported
Feature Android Firefox Mobile (Gecko) Firefox OS (Gecko) IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support Not supported Not supported Not supported Not supported Not supported Not supported Not supported

See also

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/headers/delete

API delete Experimental Expérimental Fetch Method Reference Référence