|
1 | 1 | # jquery-param
|
| 2 | + |
2 | 3 | [](https://circleci.com/gh/knowledgecode/jquery-param)
|
3 | 4 |
|
4 | 5 | ## Features
|
| 6 | + |
5 | 7 | - Equivalent to jQuery.param (based on jQuery 3.x)
|
6 | 8 | - No dependencies
|
7 | 9 | - Universal (Isomorphic)
|
8 |
| -- ES5 |
| 10 | +- ES Modules Support |
9 | 11 |
|
10 | 12 | ## Installation
|
| 13 | + |
11 | 14 | Node.js:
|
| 15 | + |
12 | 16 | ```shell
|
13 |
| -$ npm install jquery-param --save |
14 |
| -``` |
15 |
| -Bower (DEPRECATED): |
16 |
| -```shell |
17 |
| -$ bower install jquery-param |
| 17 | +npm install jquery-param --save |
18 | 18 | ```
|
| 19 | + |
19 | 20 | the browser:
|
| 21 | + |
20 | 22 | ```html
|
21 |
| -<script src="jquery-param.min.js"></script> |
| 23 | +<script src="/path/to/jquery-param.min.js"></script> |
22 | 24 | ```
|
23 | 25 |
|
24 | 26 | ## Usage
|
25 |
| -Node.js: |
| 27 | + |
| 28 | +CommonJS: |
| 29 | + |
26 | 30 | ```javascript
|
27 | 31 | const param = require('jquery-param');
|
28 | 32 |
|
29 |
| -let obj = { key1: 'value1', key2: [10, 20, 30] }; |
30 |
| -let str = param(obj); |
31 |
| -// => "key1=value1&key2[]=10&key2[]=20&key2[]=30" |
| 33 | +const obj = { key1: { value1: [10, 20, 30] }, key2: '?a=b&c=d' }; |
| 34 | +const str = param(obj); |
| 35 | +// => "key1[value1][]=10&key1[value1][]=20&key1[value1][]=30&key2=?a=b&c=d" |
32 | 36 | ```
|
33 |
| -AMD: |
| 37 | + |
| 38 | +TypeScript: |
| 39 | + |
34 | 40 | ```javascript
|
35 |
| -require(['jquery-param'], function (param) { |
36 |
| - var obj = { key1: { value1: [10, 20, 30] }, key2: '?a=b&c=d' }; |
37 |
| - var str = param(obj); |
38 |
| - // => "key1[value1][]=10&key1[value1][]=20&key1[value1][]=30&key2=?a=b&c=d" |
39 |
| -}); |
| 41 | +import param from 'jquery-param'; |
| 42 | + |
| 43 | +const obj = { key1: { value1: [10, 20, 30] }, key2: '?a=b&c=d' }; |
| 44 | +const str = param(obj); |
| 45 | +// => "key1[value1][]=10&key1[value1][]=20&key1[value1][]=30&key2=?a=b&c=d" |
40 | 46 | ```
|
41 |
| -directly: |
| 47 | + |
| 48 | +*You will need to add `"esModuleInterop": true` to the `"compilerOptions"` directive in `tsconfig.json`.* |
| 49 | + |
| 50 | +ES Modules: |
| 51 | + |
| 52 | +```html |
| 53 | +<script type="module"> |
| 54 | +import { param } from './esm/jquery-param.es.js'; |
| 55 | +
|
| 56 | +const obj = { key1: { value1: [10, 20, 30] }, key2: '?a=b&c=d' }; |
| 57 | +const str = param(obj); |
| 58 | +// => "key1[value1][]=10&key1[value1][]=20&key1[value1][]=30&key2=?a=b&c=d" |
| 59 | +</script> |
| 60 | +``` |
| 61 | + |
| 62 | +Older browser: |
| 63 | + |
42 | 64 | ```javascript
|
| 65 | +<script> |
43 | 66 | var obj = { key1: { value1: [10, 20, 30] }, key2: '?a=b&c=d' };
|
44 | 67 | var str = window.param(obj); // global object
|
45 | 68 | // => "key1[value1][]=10&key1[value1][]=20&key1[value1][]=30&key2=?a=b&c=d"
|
| 69 | +</script> |
46 | 70 | ```
|
47 | 71 |
|
48 | 72 | ## Browser Support
|
| 73 | + |
49 | 74 | Chrome, Firefox, Safari, Edge, and IE9+.
|
50 | 75 |
|
51 | 76 | ## License
|
| 77 | + |
52 | 78 | MIT
|
0 commit comments