Headers.delete

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

Browser compatibilityUpdate compatibility data on GitHub

See also

• ServiceWorker API
• HTTP access control (CORS)
• HTTP