JSPM

  • Created
  • Published
  • Downloads 49218
  • Score
    100M100P100Q200362F
  • License

HTTP message parser in JavaScript.

Package Exports

  • http-message-parser

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (http-message-parser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

http-message-parser

HTTP message parser in JavaScript.

Demo

http://lab.moogs.io/http-message-parser

Install

npm install http-message-parser

Docs

The function takes in a string or Buffer (recommended).

The result message body and multipart bodies will always return back as a Buffer in Node.js in order to retain it's original encoding, for example when it parses a response containing binary audio data it won't stringify the binary data. The library avoids stringifying the body by performing offset slices on the input buffer.

Usage

Here's an example.

multipart_example.txt

HTTP/1.1 200 OK
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary=frontier

This is a message with multiple parts in MIME format.
--frontier
Content-Type: text/plain

This is the body of the message.
--frontier
Content-Type: application/octet-stream
Content-Transfer-Encoding: base64

PGh0bWw+CiAgPGhlYWQ+CiAgPC9oZWFkPgogIDxib2R5PgogICAgPHA+VGhpcyBpcyB0aGUg
Ym9keSBvZiB0aGUgbWVzc2FnZS48L3A+CiAgPC9ib2R5Pgo8L2h0bWw+Cg==
--frontier
const httpMessageParser = require('http-message-parser');

const parsedMessage = httpMessageParser(fs.createReadStream('multipart_example.txt'));

console.log(parsedMessage);
//
{
  httpVersion: 1.1,
  statusCode: 200,
  statusMessage: 'OK',
  method: null,
  url: null,
  headers: {
    'MIME-Version': '1.0'
    'Content-Type': 'multipart/mixed; boundary=frontier'
  },
  body: <Buffer>, // "This is a message with multiple parts in MIME format."
  boundary: 'frontier',
  multipart: [
    {
      headers: {
        'Content-Type': 'text/plain'
      },
      body: <Buffer> // "This is the body of the message."
    },
    {
      headers: {
        'Content-Type': 'application/octet-stream'
        'Content-Transfer-Encoding': 'base64'
      },
      body: <Buffer> // "PGh0bWw+CiAgPGhlYWQ+CiAgPC9oZWFkPgogIDxib2R5Pgog..."
    }
  ]
}

Command Line

Parsing input file:

$ http-message-parser multipart_example.txt

Piping input file:

$ cat multipart_example.txt | http-message-parser

Piping input file and only outputing specified mulipart body:

$ cat multipart_example.txt | http-message-parser --only=multipart[0].body

Piping cURL response and outputing only specified header:

$ curl -sD - http://www.example.com/ | http-message-parser.js --only=headers[Last-Modified]

Test

npm test

License

MIT