Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/0xch4z/query-str

A lightweight, independent micro-library for parsing/generating URL query strings.
https://github.com/0xch4z/query-str

javascript json parsing query-string url-parameters

Last synced: 14 days ago
JSON representation

A lightweight, independent micro-library for parsing/generating URL query strings.

Awesome Lists containing this project

README

        

query-str



Travis Badge
Codecov Badge
Codacy Badge
NPM Version Badge
NPM Downloads Badge


Parse and stringify URL query strings with ease. 🚀

## Installation ⬇️
```bash
$ npm install --save query-str
```
API Usage 📝
-----
### Parse query string with URL
```js
const qs = require('query-str');

const myURL = 'http://foo.bar/buzz?myBool=true&myInt=2&myFloat=3.3&myString=fizz%20buzz';
qs.parse(myURL);
// => { myBool: true, myInt: 2, myFloat: 3.3, myString: 'fizz buzz' }
```

### Parse query string
```js
const qs = require('query-str');

const myURL = 'isOpenSource=true&isPassing=true&codacyScore=10.0';
qs.parse(myURL);
// => { isOpenSource: true, isPassing: true, codacyScore: 10.0 }
```

### Stringify parameter object with URL
```js
const qs = require('query-str');

const myURL = 'https://foo.bar/buzz';

const myParams = {
fin: false,
bazz: 22
};

qs.stringify(myParams, myURL);
// => 'https://foo.bar/buzz?fin=false&bazz=22'
```

### Stringify parameter object
```js
const qs = require('query-str');

const myParams = {
myBool: false,
myInt: 6,
myFloat: 3.3,
myString: 'fin fun'
};

qs.stringify(myParams);
// => '?myBool=false&myInt=6&myFloat=3.3&myString=fin%20fun'
```