preserve-qs v0.0.5

preserve-qs

Preserve querystrings during redirect and creating new URLs for Node.js and browser environments (supports Lad, Koa, Express, and Connect)

Table of Contents

• Install
• Usage
  • Custom
  • Browser
  • Koa
  • Express
• Override Properties
• Blacklist Properties
• Contributors
• License

Install

npm:

npm install preserve-qs

yarn:

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:

const preserveQs = require('preserve-qs');

Custom

preserveQs('/foo/bar?beep=boop&limit=25', '/foo/baz');

Browser

This uses window.location.pathname and window.location.search.

preserveQs(window, '/foo/baz');

Koa

This uses ctx.request.originalUrl.

preserveQs(ctx, '/foo/baz');

// ctx.redirect(preserveQs(ctx, '/foo/baz'));

Express

This uses req.originalUrl.

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.

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.

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

License

MIT © Nick Baugh