parse-headers

What is parse-headers?

The parse-headers npm package is a utility for parsing raw headers from HTTP requests or responses into a JavaScript object. It can be used to easily access header values without manually splitting and trimming strings.

What are parse-headers's main functionalities?

Parse HTTP headers

This feature allows you to convert a raw string of HTTP headers into a JavaScript object where each property corresponds to a header field. The code sample demonstrates how to parse a string of headers and log the resulting object.

const parseHeaders = require('parse-headers');
const rawHeaders = 'Content-Type: text/html\nContent-Length: 123';
const headers = parseHeaders(rawHeaders);
console.log(headers);

Other packages similar to parse-headers

http-headers

The http-headers package is similar to parse-headers in that it also parses HTTP headers. However, it provides a more comprehensive API for manipulating headers, including methods for getting and setting header values.

header-case-normalizer

While header-case-normalizer does not parse headers, it normalizes HTTP header field names to a consistent case format. This can be useful in conjunction with parse-headers to ensure header field names are uniformly formatted.

raw-headers

The raw-headers package is designed to parse raw HTTP headers and provide them as an array of raw header strings. It differs from parse-headers by not converting the headers into an object, which might be useful in cases where the original header order and case are important.

README

parse-headers

Parse http headers, works with browserify/xhr

Installation

npm install parse-headers

Example

Input

var parse = require('./parse-headers')

  , headers = [
        'Date: Sun, 17 Aug 2014 16:24:52 GMT'
      , 'Content-Type: text/html; charset=utf-8'
      , 'Transfer-Encoding: chunked'
      , 'X-Custom-Header: beep'
      , 'X-Custom-Header: boop'
    ].join('\n')

console.log(parse(headers))

Output

{ date: 'Sun, 17 Aug 2014 16:24:52 GMT',
  'content-type': 'text/html; charset=utf-8',
  'transfer-encoding': 'chunked',
  'x-custom-header': [ 'beep', 'boop' ] }

Kudos

Looked at https://github.com/watson/http-headers before creating this.

Licence

Copyright (c) 2014 David Björklund

This software is released under the MIT license:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.