Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/pillarjs/parseurl

parse a url with memoization
https://github.com/pillarjs/parseurl

javascript nodejs parse url

Last synced: about 1 month ago
JSON representation

parse a url with memoization

Host: GitHub
URL: https://github.com/pillarjs/parseurl
Owner: pillarjs
License: mit
Created: 2014-03-08T02:08:50.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-04-07T14:20:47.000Z (3 months ago)
Last Synced: 2024-04-14T02:20:12.897Z (3 months ago)
Topics: javascript, nodejs, parse, url
Language: JavaScript
Size: 96.7 KB
Stars: 189
Watchers: 15
Forks: 25
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE

Lists

awesome-nodejs - parseurl - Parse a url with memoization. ![](https://img.shields.io/github/stars/pillarjs/parseurl.svg?style=social&label=Star) (Repository / URL)
awesome-stars - pillarjs/parseurl - parse a url with memoization (JavaScript)
awesome-from-stars - pillarjs/parseurl

README

        # parseurl

[![NPM Version][npm-version-image]][npm-url]

[![NPM Downloads][npm-downloads-image]][npm-url]

[![Node.js Version][node-image]][node-url]

[![Build Status][github-actions-ci-image]][github-actions-ci-url]

[![Test Coverage][coveralls-image]][coveralls-url]

Parse a URL with memoization.

## Install

This is a [Node.js](https://nodejs.org/en/) module available through the

[npm registry](https://www.npmjs.com/). Installation is done using the

[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):

```sh

$ 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

> [email protected] bench nodejs-parseurl

> node benchmark/index.js

  [email protected]

  [email protected]

  [email protected]

  [email protected]

  [email protected]

  [email protected]

  modules@64

  [email protected]

  napi@3

  [email protected]

  [email protected]

  [email protected]

  [email protected]

  tz@2018c

> node benchmark/fullurl.js

  Parsing URL "http://localhost:8888/foo/bar?user=tj&pet=fluffy"

  4 tests completed.

  fasturl            x 2,207,842 ops/sec ±3.76% (184 runs sampled)

  nativeurl - legacy x   507,180 ops/sec ±0.82% (191 runs sampled)

  nativeurl - whatwg x   290,044 ops/sec ±1.96% (189 runs sampled)

  parseurl           x   488,907 ops/sec ±2.13% (192 runs sampled)

> node benchmark/pathquery.js

  Parsing URL "/foo/bar?user=tj&pet=fluffy"

  4 tests completed.

  fasturl            x 3,812,564 ops/sec ±3.15% (188 runs sampled)

  nativeurl - legacy x 2,651,631 ops/sec ±1.68% (189 runs sampled)

  nativeurl - whatwg x   161,837 ops/sec ±2.26% (189 runs sampled)

  parseurl           x 4,166,338 ops/sec ±2.23% (184 runs sampled)

> node benchmark/samerequest.js

  Parsing URL "/foo/bar?user=tj&pet=fluffy" on same request object

  4 tests completed.

  fasturl            x  3,821,651 ops/sec ±2.42% (185 runs sampled)

  nativeurl - legacy x  2,651,162 ops/sec ±1.90% (187 runs sampled)

  nativeurl - whatwg x    175,166 ops/sec ±1.44% (188 runs sampled)

  parseurl           x 14,912,606 ops/sec ±3.59% (183 runs sampled)

> node benchmark/simplepath.js

  Parsing URL "/foo/bar"

  4 tests completed.

  fasturl            x 12,421,765 ops/sec ±2.04% (191 runs sampled)

  nativeurl - legacy x  7,546,036 ops/sec ±1.41% (188 runs sampled)

  nativeurl - whatwg x    198,843 ops/sec ±1.83% (189 runs sampled)

  parseurl           x 24,244,006 ops/sec ±0.51% (194 runs sampled)

> node benchmark/slash.js

  Parsing URL "/"

  4 tests completed.

  fasturl            x 17,159,456 ops/sec ±3.25% (188 runs sampled)

  nativeurl - legacy x 11,635,097 ops/sec ±3.79% (184 runs sampled)

  nativeurl - whatwg x    240,693 ops/sec ±0.83% (189 runs sampled)

  parseurl           x 42,279,067 ops/sec ±0.55% (190 runs sampled)

```

## License

  [MIT](LICENSE)

[coveralls-image]: https://badgen.net/coveralls/c/github/pillarjs/parseurl/master

[coveralls-url]: https://coveralls.io/r/pillarjs/parseurl?branch=master

[github-actions-ci-image]: https://badgen.net/github/checks/pillarjs/parseurl/master?label=ci

[github-actions-ci-url]: https://github.com/pillarjs/parseurl/actions?query=workflow%3Aci

[node-image]: https://badgen.net/npm/node/parseurl

[node-url]: https://nodejs.org/en/download

[npm-downloads-image]: https://badgen.net/npm/dm/parseurl

[npm-url]: https://npmjs.org/package/parseurl

[npm-version-image]: https://badgen.net/npm/v/parseurl