121 lines
3.4 KiB
Markdown
121 lines
3.4 KiB
Markdown
# parseurl
|
|
|
|
[![NPM Version][npm-image]][npm-url]
|
|
[![NPM Downloads][downloads-image]][downloads-url]
|
|
[![Node.js Version][node-version-image]][node-version-url]
|
|
[![Build Status][travis-image]][travis-url]
|
|
[![Test Coverage][coveralls-image]][coveralls-url]
|
|
|
|
Parse a URL with memoization.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
$ npm install parseurl
|
|
```
|
|
|
|
## API
|
|
|
|
```js
|
|
var parseurl = require('parseurl')
|
|
```
|
|
|
|
### parseurl(req)
|
|
|
|
Parse the URL of the given request object (looks at the `req.url` property)
|
|
and return the result. The result is the same as `url.parse` in Node.js core.
|
|
Calling this function multiple times on the same `req` where `req.url` does
|
|
not change will return a cached parsed object, rather than parsing again.
|
|
|
|
### parseurl.original(req)
|
|
|
|
Parse the original URL of the given request object and return the result.
|
|
This works by trying to parse `req.originalUrl` if it is a string, otherwise
|
|
parses `req.url`. The result is the same as `url.parse` in Node.js core.
|
|
Calling this function multiple times on the same `req` where `req.originalUrl`
|
|
does not change will return a cached parsed object, rather than parsing again.
|
|
|
|
## Benchmark
|
|
|
|
```bash
|
|
$ npm run-script bench
|
|
|
|
> parseurl@1.3.1 bench nodejs-parseurl
|
|
> node benchmark/index.js
|
|
|
|
> node benchmark/fullurl.js
|
|
|
|
Parsing URL "http://localhost:8888/foo/bar?user=tj&pet=fluffy"
|
|
|
|
1 test completed.
|
|
2 tests completed.
|
|
3 tests completed.
|
|
|
|
fasturl x 1,290,780 ops/sec ±0.46% (195 runs sampled)
|
|
nativeurl x 56,401 ops/sec ±0.22% (196 runs sampled)
|
|
parseurl x 55,231 ops/sec ±0.22% (194 runs sampled)
|
|
|
|
> node benchmark/pathquery.js
|
|
|
|
Parsing URL "/foo/bar?user=tj&pet=fluffy"
|
|
|
|
1 test completed.
|
|
2 tests completed.
|
|
3 tests completed.
|
|
|
|
fasturl x 1,986,668 ops/sec ±0.27% (190 runs sampled)
|
|
nativeurl x 98,740 ops/sec ±0.21% (195 runs sampled)
|
|
parseurl x 2,628,171 ops/sec ±0.36% (195 runs sampled)
|
|
|
|
> node benchmark/samerequest.js
|
|
|
|
Parsing URL "/foo/bar?user=tj&pet=fluffy" on same request object
|
|
|
|
1 test completed.
|
|
2 tests completed.
|
|
3 tests completed.
|
|
|
|
fasturl x 2,184,468 ops/sec ±0.40% (194 runs sampled)
|
|
nativeurl x 99,437 ops/sec ±0.71% (194 runs sampled)
|
|
parseurl x 10,498,005 ops/sec ±0.61% (186 runs sampled)
|
|
|
|
> node benchmark/simplepath.js
|
|
|
|
Parsing URL "/foo/bar"
|
|
|
|
1 test completed.
|
|
2 tests completed.
|
|
3 tests completed.
|
|
|
|
fasturl x 4,535,825 ops/sec ±0.27% (191 runs sampled)
|
|
nativeurl x 98,769 ops/sec ±0.54% (191 runs sampled)
|
|
parseurl x 4,164,865 ops/sec ±0.34% (192 runs sampled)
|
|
|
|
> node benchmark/slash.js
|
|
|
|
Parsing URL "/"
|
|
|
|
1 test completed.
|
|
2 tests completed.
|
|
3 tests completed.
|
|
|
|
fasturl x 4,908,405 ops/sec ±0.42% (191 runs sampled)
|
|
nativeurl x 100,945 ops/sec ±0.59% (188 runs sampled)
|
|
parseurl x 4,333,208 ops/sec ±0.27% (194 runs sampled)
|
|
```
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|
|
|
|
[npm-image]: https://img.shields.io/npm/v/parseurl.svg
|
|
[npm-url]: https://npmjs.org/package/parseurl
|
|
[node-version-image]: https://img.shields.io/node/v/parseurl.svg
|
|
[node-version-url]: http://nodejs.org/download/
|
|
[travis-image]: https://img.shields.io/travis/pillarjs/parseurl/master.svg
|
|
[travis-url]: https://travis-ci.org/pillarjs/parseurl
|
|
[coveralls-image]: https://img.shields.io/coveralls/pillarjs/parseurl/master.svg
|
|
[coveralls-url]: https://coveralls.io/r/pillarjs/parseurl?branch=master
|
|
[downloads-image]: https://img.shields.io/npm/dm/parseurl.svg
|
|
[downloads-url]: https://npmjs.org/package/parseurl
|