vanilla-js-url

A lightweight module to construct and parse query parameters of URLs.

A set of functions for working with url. Easy to add parameters to url, easy to extract parameters from url. You can also get path from url.

🖐 If you find my plugin helpful, please donate me 🤝

simple get, simple add

Demo

Install

npm i vanilla-js-url

yarn add vanilla-js-url

Get started

wurl.getParams('example.com?bar=1&foo');
wurl.addParams('example.com', { bar: 1, foo: 2 });

wurl.getPath('example.com/path/to/page');

wurl.getParamsExtended('example.com?bar[roo][boo]=1&foo[puu]=test');
wurl.addParamsExtended('example.com', { bar: { foo: 'test', joo: 2 } });

getParams(url, decode)

alias get()

param	type	default
url	String	window.location.href
decode	Boolean	true

If you have simple parameters like bar=1 or foo[]=3&foo[]=5, then use getParams().
In response, you will get a simple (single-level) object whose keys will contain either simple values or simple arrays. This function is suitable in 99% of cases.

wurl.get('example.com');
// {}

wurl.get('example.com?bar=1&foo');
// { bar: '1', foo: '' }

wurl.get('example.com?bar=1&bar=2');
// { bar: '2' }

wurl.get('example.com?bar[]=1&bar[]=2');
// { bar: ['1', '2'] }

wurl.get('example.com?bar=1&bar[]=2');
// { bar: ['2'] }

addParams(url, params, encode)

alias add()

param	type	default
url	String	`required`
params	Object	`required`
encode	Boolean	false

wurl.add('example.com', { bar: 1, foo: 2 });
// example.com?bar=1&foo=2

wurl.add('example.com?bar=1&foo', { bar: 2, foo: 2 });
// example.com?bar=2&foo=2

wurl.add('example.com?bar=1', { bar: [2, 3] });
// example.com?bar[]=2&bar[]=3

wurl.add('example.com?bar=1&bar[]=2', { bar: [3, 4] });
// example.com?bar[]=2&bar[]=3&bar[]=4

getPath(url)

alias path()

param	type	default
url	String	window.location.href

wurl.path('https://example.com/path/to/page?bar=1');
// /path/to/page

getParamsExtended(url)

alias getExt()

param	type	default
url	String	window.location.href

If you have complex parameters like: bar[foo][too][poo]=3&bar[foo][goo]=4, then use getParamsExtended().
In response, you will get a multi-level object. Most likely you will not need this function.

wurl.getExt('example.com?bar[t]=1&bar[j]=2');
// { bar: { t: '1', j: '2' } }

addParamsExtended(url, params)

alias addExt()

param	type	default
url	String	`required`
params	Object	`required`

wurl.addExt('example.com', { bar: { foo: 'test', joo: 2 } });
// example.com?bar[foo]=test&bar[joo]=2

The getParamsExtended and addParamsExtended functions may not answer exactly. Please tell me which tests failed.

MIT LICENSE

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.

worka/vanilla-js-url