Add .parseUrl() method (#104)

index.js

@@ -212,3 +212,10 @@ exports.stringify = function (obj, opts) {
  return x.length > 0;
  }).join('&') : '';
 };
+
+exports.parseUrl = function (str, opts) {
+ return {
+ url: str.split('?')[0] || '',
+ query: this.parse(this.extract(str), opts)
+ };
+};

readme.md

@@ -163,6 +163,20 @@ If omitted, keys are sorted using `Array#sort`, which means, converting them to
 Extract a query string from a URL that can be passed into `.parse()`.
 
 
+### .parseUrl(*string*, *[options]*)
+
+Extract the URL and the query string as an object.
+
+The `options` are the same as for `.parse()`.
+
+Returns an object with a `url` and `query` property.
+
+```js
+queryString.parseUrl('http://foo.bar?foo=bar')
+//=> {url: 'http://foo.bar', query: {foo: 'bar'}}
+```
+
+
 ## Nesting
 
 This module intentionally doesn't support nesting as it's not spec'd and varies between implementations, which causes a lot of [edge cases](https://github.com/visionmedia/node-querystring/issues).

test/parse-url.js

@@ -0,0 +1,17 @@
+import test from 'ava';
+import fn from '../';
+
+test('should handle strings with query string', t => {
+ t.deepEqual(fn.parseUrl('http://foo.bar?foo=bar'), {url: 'http://foo.bar', query: {foo: 'bar'}});
+ t.deepEqual(fn.parseUrl('http://foo.bar?foo=bar&foo=baz'), {url: 'http://foo.bar', query: {foo: ['bar', 'baz']}});
+});
+
+test('should handle strings not containing query string', t => {
+ t.deepEqual(fn.parseUrl('http://foo.bar/'), {url: 'http://foo.bar/', query: {}});
+ t.deepEqual(fn.parseUrl(''), {url: '', query: {}});
+});
+
+test('should throw for invalid values', t => {
+ t.throws(fn.parseUrl.bind(fn, null), TypeError);
+ t.throws(fn.parseUrl.bind(fn, undefined), TypeError);
+});