url-set-query
v1.0.0
Published
small function to append a query string to a URL
Downloads
1,089,599
Maintainers
Readme
url-set-query
Small standalone function to set a query string on a URL, replacing the existing query and leaving the hash in place.
Example
var setQuery = require('url-set-query')
setQuery('http://foo.com/index.html?state=open', 'beep=true')
//=> 'http://foo.com/index.html?beep=true'
setQuery('http://foo.com/some/path#about', '?foo=5&open=true')
//=> 'http://foo.com/some/path?foo=5&open=true#about'
setQuery('http://foo.com', 'foo=5')
//=> 'http://foo.com/?foo=5'
// clears the query
setQuery('http://foo.com/index.html?filter=closed#about', '?')
//=> 'http://foo.com/index.html#about'
Install
npm install url-set-query --save
Usage
url = setQuery(url, [query])
Appends the given query
String onto the URL, before the hash. If a query already exists, it will be replaced. Returns the new URL.
If query
is '?'
, it is the same as clearing the query string from the url
.
If query
is an empty string or undefined, no change will be made to url
.
See Also
To encode/decode from an object, see one of:
License
MIT, see LICENSE.md for details.