# url-set-query

> small function to append a query string to a URL

Latest version **1.0.0** (published 2015-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install url-set-query
pnpm add url-set-query
yarn add url-set-query
bun add url-set-query
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-07-25 |
| First published | 2015-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Matt DesLauriers |
| Maintainers | mattdesl |
| Keywords | query, string, url, hash, querystring, qs, browser, node, queries, uri |

## Links

- npm: https://www.npmjs.com/package/url-set-query
- Repository: https://github.com/mattdesl/url-set-query
- Issues: https://github.com/mattdesl/url-set-query/issues
- npm.io page: https://npm.io/package/url-set-query

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2015-07-25

## README

# url-set-query

[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)

Small standalone function to set a query string on a URL, replacing the existing query and leaving the hash in place.

## Example

```js
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

```sh
npm install url-set-query --save
```

## Usage

[![NPM](https://nodei.co/npm/url-set-query.png)](https://www.npmjs.com/package/url-set-query)

#### `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:

- [querystring](https://www.npmjs.com/package/querystring)
- [query-string](https://www.npmjs.com/package/query-string)
- [qs](https://www.npmjs.com/package/qs)


## License

MIT, see [LICENSE.md](http://github.com/mattdesl/url-set-query/blob/master/LICENSE.md) for details.

---
_Source: https://npm.io/package/url-set-query · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._