http.isValidHeaderName

History

http.isValidHeaderName(name): boolean

Attributes

name:any

Returns:boolean

Returns true if name is a valid HTTP header name (a non-empty string that is an HTTP token), and false otherwise. This is the same check that http.validateHeaderName() performs, but the result is returned instead of an error being thrown, so it is suitable for use in hot paths where invalid input is expected.

HTTP methods are also tokens, so this function can validate them as well.

import { isValidHeaderName } from 'node:http';

console.log(isValidHeaderName('content-type')); // true
console.log(isValidHeaderName('X-Request-Id')); // true
console.log(isValidHeaderName('')); // false
console.log(isValidHeaderName('bad header')); // false
console.log(isValidHeaderName(42)); // false

JavaScript

const { isValidHeaderName } = require('node:http');

console.log(isValidHeaderName('content-type')); // true
console.log(isValidHeaderName('X-Request-Id')); // true
console.log(isValidHeaderName('')); // false
console.log(isValidHeaderName('bad header')); // false
console.log(isValidHeaderName(42)); // false

JavaScript