qsm

qsm

A simple tool that allows you to add and remove any querystring from the url

Showing:

Popularity

Downloads/wk

47

GitHub Stars

10

Maintenance

Last Commit

1yr ago

Contributors

6

Package

Dependencies

0

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Reviews

Average Rating

5.0/51
Read All Reviews

Top Feedback

1Great Documentation
1Easy to Use
1Performant
1Responsive Maintainers

Readme

Query String Manager Build Status

A simple tool that allows you to add and remove any querystring from the url

Install

npm install --save qsm

Usage

var qsm = require('qsm');

Add

Appends querystring to the url.

var url = 'http://mywebsite.com';
var newUrl = qsm.add(url, { userId: 1337 });

// newUrl outputs: http://mywebsite.com?userId=1337

Remove

Removes any querystring by key

var url = 'http://mywebsite.com?userId=1337&sort=type';
var newurl = qsm.remove(url, 'userId');

// newurl outputs: http://mywebsite.com?sort=type

Clear

Clears all querystrings from the url

var url = 'http://mywebsite.com?userId=1337&sort=type';
var newurl = qsm.clear(url);

// newurl outputs: http://mywebsite.com

Replace

Replaces current querystrings with new ones.

var url = 'http://mywebsite.com?userId=1337&sort=type';
var newurl = qsm.replace(url, { hasObject: true });

// newurl outputs: http://mywebsite.com?hasObject=true

Exist

Checks if the current url has the querystring. returns boolean

var exists = qsm.exist('http://mywebsite.com?userId=1337&sort=type', 'userId');

// exists returns true

Get

Gets the value by key from the url returns either string or null

var userIds = qsm.get('http://mywebsite.com?userId=1336,1337,1338&sort=type', 'userId');

// userIds returns: "1336,1337,1338"
// or if it doesnt exist: null

Objectify

Transforms the querystring to a javascript object returns object

var queryObject = qsm.objectify('http://mywebsite.com?userId=1336,1337,1338&sort=type&active=true');

// queryObject returns: 
// {
//  userId: [1336,1337,1339],
//  sort: "type",
//  active: true
// }

Encode

Encodes an object or string to base64-string and appends it to the url as Q parameter.
this uses qsm.add() method in the background, so it appends it to the Q parameter.

var obj = {a: 'QSM', version: 1.2};
var url = qsm.encode('www.myurl.com', obj);
// url === 'www.myurl.com?q=e2E6ICdRU00nLCB2ZXJzaW9uOiAxLjJ9'

Encode with specific parameter

var obj = {a: 'QSM', version: 1.2};
var url = qsm.encode('www.myurl.com', obj, 'appVersion');
// url === 'www.myurl.com?appVersion=e2E6ICdRU00nLCB2ZXJzaW9uOiAxLjJ9'

Decode

Decodes an query string from the inputted URL, returns either string or object. Decodes by default the Q parameter

var url = 'www.myurl.com?q=e2E6ICdRU00nLCB2ZXJzaW9uOiAxLjJ9';
var ret = qsm.decode(url);
// ret === {a: 'QSM', version: 1.2};

Decode with specific parameter

var url = 'www.myurl.com?appVersion=e2E6ICdRU00nLCB2ZXJzaW9uOiAxLjJ9';
var ret = qsm.decode(url, 'appVersion');
// ret === {a: 'QSM', version: 1.2};

Changelog

All notable changes on this project will be documented in this file.

2.0.0 - 2017-11-17

Added

  • Gave add function a sort() on object keys so it always returns the same URL even if the keys are shuffled, this is a must have for SEO:ers, before you had to manage the object passed in to add by youself, now qsm handles this for you.
  • Fixed so that add updates values for keys that already exists instead of appending them, there was issues when you could get multiple occurrences of the same key in your url.
  • Added a warning for users using the soon to be deprecated technique with arrays instead of pure objects. Arrays will be deprecated in next major release.

1.3.0 - 2017-04-28

Changed

  • Changed how encode and decode works, they now both support of specifiying key that should get the encoded result or what key to decode. Instead of always using the q key for this.

Rate & Review

Great Documentation1
Easy to Use1
Performant1
Highly Customizable0
Bleeding Edge0
Responsive Maintainers1
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
Lucas Reppe WelanderMärsta, Stockholm1 Rating0 Reviews
software developer at @startdeliver
October 9, 2020
Easy to Use
Great Documentation
Performant
Responsive Maintainers

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial