Queryparams NPM | npm.io

1.2.2 • Published 3 years ago

Install

Weekly downloads

238

License

MIT

Repository

Last release

3 years ago

queryparams

What is this?

A library to help you receive and update parameters in the querystring.

Why should I use it?

You want to limit the types of parameters you receive from the querystring.
You need to set some default values and want any values coming from the querystring to be cast as the same type.
You need a simple interface to reconfigure those values and redirect to a correctly updated querystring.

Installation

yarn add queryparams
# or
npm i queryparams --save

Usage

Assume we have a querystring with a value of:

"?speed=200&color=blue";

Set defaults and infer types

import { configure } from "queryparams";

const { params } = configure({ visible: true, speed: 500, color: "red" });

// params: {
//   visible: boolean;
//   speed: number;
//   color: string;
// }

Values in the querystring override the default values and are coerced into matching types.

const { schema } = configure({
  visible: true,
  speed: 500,
  color: "red",
});

// schema => [
//   { param: 'visible', default: true, type: 'boolean' },
//   { param: 'speed', default: 500, type: 'number' },
//   { param: 'color', default: 'red', type: 'string' }
]

Reconfiguring the querystring

const { reconfigure, encode } = configure({ message: "default", size: 9 });

encode({ message: "next", size: 66 }); // => 'message=next&size=66'
encode({ message: "next", size: "notanumber" }); // => Uncaught Error: size should be a number
encode({ weird: true }); // => Uncaught Error: weird should be undefined

// redirects to `?message=new&size=5`; enforces that types match defaults provided
reconfigure({ message: "new", size: 5 });

querystring params

@everything-registry/sub-chunk-2513 @infinitebrahmanuniverse/nolb-quer

3 years ago

3 years ago

1.2.2-canary.133.677.0

3 years ago

1.3.0-canary.131.668.0

3 years ago

3 years ago

1.2.0-canary.120.562.0

3 years ago

3 years ago

1.0.53-canary.67.287.0

4 years ago

1.0.53-canary.21.285.0

4 years ago

4 years ago

1.0.52-canary.66.281.0

4 years ago

1.0.52-canary.38.279.0

4 years ago

4 years ago

1.0.52-canary.21.277.0

4 years ago

1.0.51-canary.65.273.0

4 years ago

1.0.51-canary.65.271.0

4 years ago

4 years ago

1.0.50-canary.64.267.0

4 years ago

4 years ago

4 years ago

1.0.49-canary.63.263.0

4 years ago

1.0.48-canary.62.259.0

4 years ago

4 years ago

1.0.47-canary.21.253.0

4 years ago

1.0.47-canary.61.255.0

4 years ago

1.0.47-canary.38.251.0

4 years ago

4 years ago

1.0.46-canary.60.247.0

4 years ago

1.0.46-canary.38.245.0

4 years ago

4 years ago

1.0.45-canary.59.242.0

4 years ago

4 years ago

1.0.44-canary.58.235.0

4 years ago

1.0.44-canary.38.237.0

4 years ago

4 years ago

1.0.43-canary.57.231.0

4 years ago

4 years ago

1.0.42-canary.56.227.0

4 years ago

1.0.42-canary.38.225.0

4 years ago

1.0.42-canary.21.223.0

4 years ago

1.0.40-canary.54.213.0

4 years ago

4 years ago

4 years ago

1.0.41-canary.55.216.0

4 years ago

1.0.40-canary.53.211.0

4 years ago

1.0.42-canary.21.221.0

4 years ago

4 years ago

1.0.39-canary.52.207.0

4 years ago

1.0.38-canary.51.203.0

4 years ago

4 years ago

1.0.38-canary.21.201.0

4 years ago

4 years ago

1.0.37-canary.50.197.0

4 years ago

1.0.36-canary.49.193.0

4 years ago

4 years ago

4 years ago

1.0.35-canary.48.189.0

4 years ago

4 years ago

1.0.34-canary.47.185.0

4 years ago

1.0.34-canary.47.183.0

4 years ago

1.0.33-canary.38.177.0

4 years ago

4 years ago

4 years ago

1.0.33-canary.46.179.0

4 years ago

1.0.32-canary.45.173.0

4 years ago

4 years ago

1.0.31-canary.44.169.0

4 years ago

1.0.31-canary.21.167.0

4 years ago

1.0.30-canary.43.163.0

4 years ago

4 years ago

4 years ago

1.0.29-canary.42.159.0

4 years ago

4 years ago

4 years ago

1.0.28-canary.41.155.0

4 years ago

1.0.27-canary.40.151.0

4 years ago

1.0.27-canary.40.147.0

4 years ago

1.0.27-canary.40.149.0

4 years ago

1.0.27-canary.40.145.0

4 years ago

1.0.27-canary.38.143.0

4 years ago

1.0.27-canary.38.141.0

4 years ago

1.0.27-canary.38.139.0

4 years ago

4 years ago

1.0.27-canary.21.137.0

4 years ago

1.0.26-canary.39.133.0

4 years ago

1.0.26-canary.21.131.0

4 years ago

1.0.26-canary.38.129.0

4 years ago

4 years ago

1.0.25-canary.37.125.0

4 years ago

4 years ago

1.0.25-canary.21.123.0

4 years ago

4 years ago

1.0.24-canary.36.119.0

4 years ago

1.0.23-canary.35.115.0

4 years ago

1.0.23-canary.35.113.0

4 years ago

4 years ago

1.0.22-canary.34.109.0

4 years ago

1.0.22-canary.21.107.0

4 years ago

4 years ago

4 years ago

1.0.21-canary.33.103.0

4 years ago

1.0.20-canary.32.99.0

4 years ago

1.0.20-canary.32.97.0

4 years ago

4 years ago

4 years ago

1.0.19-canary.31.93.0

4 years ago

1.0.18-canary.30.89.0

4 years ago

4 years ago

1.0.17-canary.29.85.0

4 years ago

4 years ago

1.0.16-canary.28.79.0

4 years ago

1.0.17-canary.29.83.0

4 years ago

1.0.16-canary.28.77.0

4 years ago

1.0.16-canary.21.75.0

4 years ago

4 years ago

4 years ago

1.0.14-canary.27.69.0

4 years ago

1.0.14-canary.26.67.0

4 years ago

4 years ago

1.0.12-canary.24.55.0

4 years ago

1.0.13-canary.26.63.0

4 years ago

1.0.13-canary.25.61.0

4 years ago

4 years ago

1.0.12-canary.25.57.0

4 years ago

4 years ago

4 years ago

1.0.10-canary.22.49.0

4 years ago

1.0.10-canary.23.47.0

4 years ago

1.0.10-canary.22.46.0

4 years ago

4 years ago

1.0.9-canary.20.41.0

4 years ago

1.0.9-canary.21.37.0

4 years ago

1.0.9-canary.20.39.0

4 years ago

1.0.9-canary.20.35.0

4 years ago

4 years ago

1.0.8-canary.19.31.0

4 years ago

4 years ago

1.0.7-canary.18.27.0

4 years ago

4 years ago

4 years ago

1.0.5-canary.16.19.0

4 years ago

1.0.6-canary.17.23.0

4 years ago

1.0.4-canary.15.15.0

4 years ago

4 years ago

1.0.4-canary.14.796447a.0

4 years ago

4 years ago

4 years ago

4 years ago

1.0.1-canary.9.5.0

4 years ago

1.0.1-canary.13.2.0

4 years ago

4 years ago

1.0.1-canary.1.4ee23d6.0

4 years ago

7 years ago

7 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago