Skip to content

Commit 3fc3b5a

Browse files
author
Lucas Reppe Welander
committed
update of readme
1 parent 58599d9 commit 3fc3b5a

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,26 @@ var url = qsm.encode('www.myurl.com', obj);
9292

9393
```
9494

95+
#### Encode with specific parameter
96+
```javascript
97+
var obj = {a: 'QSM', version: 1.2};
98+
var url = qsm.encode('www.myurl.com', obj, 'appVersion');
99+
// url === 'www.myurl.com?appVersion=e2E6ICdRU00nLCB2ZXJzaW9uOiAxLjJ9'
100+
101+
```
102+
95103
### Decode
96104
Decodes an query string from the inputted URL, returns either string or object.
105+
*Decodes by default the Q parameter*
97106
```javascript
98107
var url = 'www.myurl.com?q=e2E6ICdRU00nLCB2ZXJzaW9uOiAxLjJ9';
99-
var ret = qsm.decode(url, 'q');
108+
var ret = qsm.decode(url);
100109
// ret === {a: 'QSM', version: 1.2};
101110
```
111+
112+
#### Decode with specific parameter
113+
```javascript
114+
var url = 'www.myurl.com?appVersion=e2E6ICdRU00nLCB2ZXJzaW9uOiAxLjJ9';
115+
var ret = qsm.decode(url, 'appVersion');
116+
// ret === {a: 'QSM', version: 1.2};
117+
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "qsm",
3-
"version": "1.2.3",
3+
"version": "1.3",
44
"description": "a simple tool that allows you to remove any querystring from the url",
55
"main": "qsm.js",
66
"scripts": {

0 commit comments

Comments
 (0)