#Introduction

Fast implementation of an url parser for node.js.

#Quick start

npm install @kamilkisiela/fast-url-parser

var url = require("@kamilkisiela/fast-url-parser");

#API

This module has exactly the same API and semantics as the require("url");- module that comes with node.

See Node.JS URL API documentation.

In addition, you may inject a custom query string implementation by setting the url.queryString property. The module export object must expose the methods .parse and .stringify. By default the core "querystring" module is used.

You may disable automatic escaping of some characters when parsing an URL by passing true as a forth argument so that: url.format(url.parse(yourUrl, false, false, true)) == yourUrl

Example:

var url = require("@kamilkisiela/fast-url-parser");
// the querystringparser module supports nested properties
url.queryString = require("querystringparser");
var parsed = Url.parse('/path?user[name][first]=tj&user[name][last]=holowaychuk', true);
console.log(parsed.query);
//{ user: { name: { first: 'tj', last: 'holowaychuk' } } }

If in your application you may want all modules use this parser automatically, you can do so by inserting this line at the beginning of your application:

require("fast-url-parser").replace();

Anything that now calls require("url") will instead get an instance of this module instead of the url parser that comes with node core.

#Performance

Petka Antonov@PETKAANTONOV-PC ~/urlparser (master)
$ node ./benchmark/urlparser.js
misc/url.js parse(): 340437.12
misc/url.js format(): 447742.86
misc/url.js resolve("../foo/bar?baz=boom"): 415350.70
misc/url.js resolve("foo/bar"): 437834.74
misc/url.js resolve("http://nodejs.org"): 456145.28
misc/url.js resolve("./foo/bar?baz"): 454950.19

Petka Antonov@PETKAANTONOV-PC ~/urlparser (master)
$ node ./benchmark/nodecore.js
misc/url.js parse(): 148739.92
misc/url.js format(): 117072.05
misc/url.js resolve("../foo/bar?baz=boom"): 135131.15
misc/url.js resolve("foo/bar"): 119247.59
misc/url.js resolve("http://nodejs.org"): 131443.62
misc/url.js resolve("./foo/bar?baz"): 131831.52

#License

MIT License:

Copyright (c) 2014 Petka Antonov

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.