Headers.delete()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage 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 specification 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

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:

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

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

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

You can then delete it again:

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 Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 42
41 behind pref
 
(Yes) 39 (39)
34 behind pref
No support

29
28 behind pref

No support
Feature Android Edge Firefox Mobile (Gecko) Firefox OS (Gecko) IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support No support (Yes) No support No support No support No support No support No support

See also

Document Tags and Contributors

 Contributors to this page: erikadoyle, chrisdavidmills, jpmedley, kscarfone
 Last updated by: erikadoyle,