Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ladjs/preserve-qs
Preserve querystrings during redirect and creating new URLs for Node.js and browser environments (supports Lad, Koa, Express, and Connect)
https://github.com/ladjs/preserve-qs
browser connect express javascript koa lad merge node preserve querystring redirect redirection request url window
Last synced: about 1 month ago
JSON representation
Preserve querystrings during redirect and creating new URLs for Node.js and browser environments (supports Lad, Koa, Express, and Connect)
- Host: GitHub
- URL: https://github.com/ladjs/preserve-qs
- Owner: ladjs
- License: mit
- Created: 2018-01-18T19:42:56.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-08T15:39:03.000Z (almost 3 years ago)
- Last Synced: 2024-12-30T09:48:08.667Z (about 1 month ago)
- Topics: browser, connect, express, javascript, koa, lad, merge, node, preserve, querystring, redirect, redirection, request, url, window
- Language: JavaScript
- Size: 88.9 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# preserve-qs
[](https://travis-ci.org/niftylettuce/preserve-qs)
[](https://codecov.io/gh/niftylettuce/preserve-qs)
[](https://github.com/sindresorhus/xo)
[](https://github.com/prettier/prettier)
[](https://lass.js.org)
[](LICENSE)
> Preserve querystrings during redirect and creating new URLs for [Node.js][node] and browser environments (supports [Lad][], [Koa][], [Express][], and [Connect][])
## Table of Contents
* [Install](#install)
* [Usage](#usage)
* [Custom](#custom)
* [Browser](#browser)
* [Koa](#koa)
* [Express](#express)
* [Override Properties](#override-properties)
* [Blacklist Properties](#blacklist-properties)
* [Contributors](#contributors)
* [License](#license)
## Install
[npm][]:
```sh
npm install preserve-qs
```
[yarn][]:
```sh
yarn add preserve-qs
```
## Usage
Imagine that we have the URL `/foo/bar?beep=boop&limit=25` and we wish to redirect the user (or simply output) a new URL with pathname of `/foo/baz` – but also preserve the original querystring.
The examples below show how this package can be used for this, regardless of the environment being run in.
We assume you have imported the package in all these examples:
```js
const preserveQs = require('preserve-qs');
```
### Custom
```js
preserveQs('/foo/bar?beep=boop&limit=25', '/foo/baz');
```
### Browser
This uses `window.location.pathname` and `window.location.search`.
```js
preserveQs(window, '/foo/baz');
```
### Koa
This uses `ctx.request.originalUrl`.
```js
preserveQs(ctx, '/foo/baz');
// ctx.redirect(preserveQs(ctx, '/foo/baz'));
```
### Express
This uses `req.originalUrl`.
```js
preserveQs(req, '/foo/baz');
// res.redirect(preserveQs(req, '/foo/baz'));
```
## Override Properties
If you wish to override a property in the querystring, either from the original or the new URL, then you can pass a third argument of an object.
```js
preserveQs(req, '/foo/baz?hello=false', { hello: true });
```
In the example above, the output would have the `?hello=false` be overriden and become `?hello=true`.
## Blacklist Properties
If you wish to completely strip a single property or multiple from being included in the querystring then pass it as the third or fourth argument.
```js
preserveQs(req, '/foo/baz', [ 'page', 'limit' ]);
```
This would strip the `page` and `limit` from the URL (e.g. it would not have `?page=1&limit=10` in the URL).
You can also combine this with the `override` argument by invoking in order as `preserveQs(req, url, override, blacklist)`.
## Contributors
| Name | Website |
| -------------- | -------------------------- |
| **Nick Baugh** | |
## License
[MIT](LICENSE) © [Nick Baugh](http://niftylettuce.com/)
##
[npm]: https://www.npmjs.com/
[yarn]: https://yarnpkg.com/
[node]: https://nodejs.org/
[lad]: https://lad.js.org/
[koa]: http://koajs.com/
[express]: https://expressjs.com/
[connect]: https://github.com/senchalabs/connect