|
Last change
on this file was 9af201e, checked in by MBK <marija.karapandzova@…>, 11 days ago |
|
Fix frontend appearance
|
-
Property mode
set to
100644
|
|
File size:
1.8 KB
|
| Line | |
|---|
| 1 | 
|
|---|
| 2 | 
|
|---|
| 3 |
|
|---|
| 4 | # HTTP Parser
|
|---|
| 5 |
|
|---|
| 6 | This library parses HTTP protocol for requests and responses.
|
|---|
| 7 | It was created to replace `http_parser.c` since calling C++ functions from JS is really slow in V8.
|
|---|
| 8 | However, it is now primarily useful in having a more flexible/tolerant HTTP parser when dealing with legacy services that do not meet the strict HTTP parsing rules Node's parser follows.
|
|---|
| 9 |
|
|---|
| 10 | This is packaged as a standalone npm module.
|
|---|
| 11 | To use in node, monkeypatch HTTPParser.
|
|---|
| 12 |
|
|---|
| 13 | ```js
|
|---|
| 14 | // Monkey patch before you require http for the first time.
|
|---|
| 15 | process.binding('http_parser').HTTPParser = require('http-parser-js').HTTPParser;
|
|---|
| 16 |
|
|---|
| 17 | var http = require('http');
|
|---|
| 18 | // ...
|
|---|
| 19 | ```
|
|---|
| 20 |
|
|---|
| 21 | ## Testing
|
|---|
| 22 |
|
|---|
| 23 | Simply run `npm test`.
|
|---|
| 24 | The tests are copied from node and mscedex/io.js, with some modifcations.
|
|---|
| 25 |
|
|---|
| 26 | ## Status
|
|---|
| 27 |
|
|---|
| 28 | This should now be usable in any node application, it now supports (nearly) everything `http_parser.c` does while still being tolerant with corrupted headers, and other kinds of malformed data.
|
|---|
| 29 |
|
|---|
| 30 | ### Node versions
|
|---|
| 31 |
|
|---|
| 32 | `http-parser-js` should work via monkey-patching on Node v6-v11, and v13-14.
|
|---|
| 33 |
|
|---|
| 34 | Node v12.x renamed the internal http parser, and did not expose it for monkey-patching, so to be able to monkey-patch on Node v12, you must run `node --http-parser=legacy file.js` to opt in to the old, monkey-patchable http_parser binding.
|
|---|
| 35 |
|
|---|
| 36 | ## Standalone usage
|
|---|
| 37 |
|
|---|
| 38 | While this module is intended to be used as a replacement for the internal Node.js parser, it can be used as a standalone parser. The [`standalone-example.js`](standalone-example.js) demonstrates how to use the somewhat awkward API (coming from compatibility with the Node.js internals) to parse HTTP from raw Buffers.
|
|---|
| 39 |
|
|---|
| 40 | ## License
|
|---|
| 41 |
|
|---|
| 42 | MIT.
|
|---|
| 43 | See [LICENSE.md](LICENSE.md)
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.