source: trip-planner-front/node_modules/querystringify/README.md@ 8d391a1

Last change on this file since 8d391a1 was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 2.3 KB
Line 
1# querystringify
2
3[![Version npm](http://img.shields.io/npm/v/querystringify.svg?style=flat-square)](https://www.npmjs.com/package/querystringify)[![Build Status](http://img.shields.io/travis/unshiftio/querystringify/master.svg?style=flat-square)](https://travis-ci.org/unshiftio/querystringify)[![Dependencies](https://img.shields.io/david/unshiftio/querystringify.svg?style=flat-square)](https://david-dm.org/unshiftio/querystringify)[![Coverage Status](http://img.shields.io/coveralls/unshiftio/querystringify/master.svg?style=flat-square)](https://coveralls.io/r/unshiftio/querystringify?branch=master)
4
5A somewhat JSON compatible interface for query string parsing. This query string
6parser is dumb, don't expect to much from it as it only wants to parse simple
7query strings. If you want to parse complex, multi level and deeply nested
8query strings then you should ask your self. WTF am I doing?
9
10## Installation
11
12This module is released in npm as `querystringify`. It's also compatible with
13`browserify` so it can be used on the server as well as on the client. To
14install it simply run the following command from your CLI:
15
16```
17npm install --save querystringify
18```
19
20## Usage
21
22In the following examples we assume that you've already required the library as:
23
24```js
25'use strict';
26
27var qs = require('querystringify');
28```
29
30### qs.parse()
31
32The parse method transforms a given query string in to an object. Parameters
33without values are set to empty strings. It does not care if your query string
34is prefixed with a `?`, a `#`, or not prefixed. It just extracts the parts
35between the `=` and `&`:
36
37```js
38qs.parse('?foo=bar'); // { foo: 'bar' }
39qs.parse('#foo=bar'); // { foo: 'bar' }
40qs.parse('foo=bar'); // { foo: 'bar' }
41qs.parse('foo=bar&bar=foo'); // { foo: 'bar', bar: 'foo' }
42qs.parse('foo&bar=foo'); // { foo: '', bar: 'foo' }
43```
44
45### qs.stringify()
46
47This transforms a given object in to a query string. By default we return the
48query string without a `?` prefix. If you want to prefix it by default simply
49supply `true` as second argument. If it should be prefixed by something else
50simply supply a string with the prefix value as second argument:
51
52```js
53qs.stringify({ foo: bar }); // foo=bar
54qs.stringify({ foo: bar }, true); // ?foo=bar
55qs.stringify({ foo: bar }, '#'); // #foo=bar
56qs.stringify({ foo: '' }, '&'); // &foo=
57```
58
59## License
60
61MIT
Note: See TracBrowser for help on using the repository browser.