0.6.0

Author: yanhaijing

CHANGELOG.md

@@ -1,5 +1,11 @@
 # 变更日志
 
+## 0.6.0 / 2019-3-19
+
+- feat: parse的decode增加isKey参数
+- feat: stringify的encode增加isKey参数
+- feat: stringify新增addQueryPrefix参数
+
 ## 0.5.0 / 2019-3-19
 
 - feat: parse新增filter和reduce参数

README.md

@@ -3,7 +3,7 @@
 [![](https://img.shields.io/badge/Powered%20by-jslib%20querystring-brightgreen.svg)](https://github.com/yanhaijing/jslib-querystring)
 [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jsmini/querystring/blob/master/LICENSE)
 [![Build Status](https://travis-ci.org/jsmini/querystring.svg?branch=master)](https://travis-ci.org/jsmini/querystring)
-[![npm](https://img.shields.io/badge/npm-0.5.0-orange.svg)](https://www.npmjs.com/package/@jsmini/querystring)
+[![npm](https://img.shields.io/badge/npm-0.6.0-orange.svg)](https://www.npmjs.com/package/@jsmini/querystring)
 [![NPM downloads](http://img.shields.io/npm/dm/@jsmini/querystring.svg?style=flat-square)](http://www.npmtrends.com/@jsmini/querystring)
 [![Percentage of issues still open](http://isitmaintained.com/badge/open/jsmini/querystring.svg)](http://isitmaintained.com/project/jsmini/querystring "Percentage of issues still open")
 

doc/api.md

@@ -11,7 +11,7 @@ url参数处理库
 - param {string} [option.sep='&'] 参数分隔符
 - param {string} [option.eq='='] 参数赋值符
 - param {boolean} [option.ignoreQueryPrefix=false] 忽略参数中的`?`
-- param {function} [option.decode=decodeURIComponent] 对参数进行解码的函数
+- param {function} [option.decode=(x, isKey)] 对参数进行解码的函数
 - param {function} [option.filter=(v, k) => true] 对数据进行过滤
 - param {function} [option.convert=(v, k)] 对数据进行转换
 - param {function} [option.reduce=(prev, v, k)] 自定义数据处理流程
@@ -70,7 +70,8 @@ parse('a=1&a=2&a=3', {
 - param {object} [option] 可选参数
 - param {string} [option.sep='&'] 参数分隔符
 - param {string} [option.eq='='] 参数赋值符
-- param {function} [option.encode=encodeURIComponent] 对参数进行编码的函数
+- param {boolean} [option.addQueryPrefix=false] 是否在前面添加?
+- param {function} [option.encode=(x, isKey)] 对参数进行编码的函数
 - param {function} [option.filter=(v, k) => true] 对数据进行过滤
 - param {function} [option.convert=(v, k) => /*undefined null -> ''*/] 对数据进行转换
 - param {function} [option.reduce=(prev, v, k)] 自定义数据处理流程

index.d.ts

@@ -4,7 +4,7 @@ interface parseOption {
     sep?: string;
     eq?: string;
     ignoreQueryPrefix?: boolean;
-    decode?: (x: string) => string;
+    decode?: (x: string, isKey?: boolean) => string;
     filter?: (v: string, k?: string) => boolean;
     convert?: (v: string, k?: string) => any;
     reduce?: (prev: object, v: string, k?: string) => object;
@@ -13,7 +13,8 @@ interface parseOption {
 interface stringifyOption {
     sep?: string;
     eq?: string;
-    encode?: (x: string) => string;
+    addQueryPrefix?: boolean;
+    encode?: (x: string, isKey?: boolean) => string;
     filter?: (v: any, k?: string) => boolean;
     convert?: (v: any, k?: string) => any;
     reduce?: (prev: object[], v: any, k?: string) => object[];

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsmini/querystring",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "最好用的js第三方库脚手架",
   "main": "dist/index.js",
   "jsnext:main": "dist/index.esm.js",

src/index.js

@@ -11,7 +11,7 @@ export function parse(str, option = {}) {
         sep: '&',
         eq: '=',
         ignoreQueryPrefix: false,
-        decode: decodeURIComponent,
+        decode: (x, iskey) => decodeURIComponent(x),
         filter: (v, k) => true,
         convert: (v, k) => v,
         reduce: false, // (prev, v, k) => prev
@@ -31,7 +31,7 @@ export function parse(str, option = {}) {
 
     for (let i = 0; i < arr.length; i++) {
         const arr2 = arr[i].split(opt.eq);
-        const k = isDecode ? opt.decode(arr2[0]) : arr2[0];
+        const k = isDecode ? opt.decode(arr2[0], true) : arr2[0];
         const v = isDecode ? opt.decode(arr2[1]) : arr2[1];
 
         if (opt.filter(v, k)) {
@@ -58,7 +58,8 @@ export function stringify(obj, option = {}) {
     const opt = extend({
         sep: '&',
         eq: '=',
-        encode: encodeURIComponent,
+        addQueryPrefix: false,
+        encode: (x, isKey) => encodeURIComponent(x),
         filter: (v, k) => true,
         // undefined or null > ''
         convert: (v, k) => typeof v === 'undefined' || v === null ? '' : v,
@@ -81,9 +82,9 @@ export function stringify(obj, option = {}) {
 
     let str = '';
     for (let i = 0; i < res.length; i++) {
-        const k = isEncode ? opt.encode(res[i].k) : res[i].k;
+        const k = isEncode ? opt.encode(res[i].k, true) : res[i].k;
         const v = isEncode ? opt.encode(res[i].v) : res[i].v;
         str = str + (str === '' ? '' : opt.sep) + k + opt.eq + v;
     }
-    return str;
+    return opt.addQueryPrefix ? '?' + str : str;
 }

test/test.js

@@ -38,6 +38,9 @@ describe('单元测试', function() {
 
             var a = parse('a=%3D', { decode: function (x) {return x} })
             expect(a).to.eql({ a: '%3D'});
+
+            var a = parse('a=%3D', { decode: function (x, isKey) {return isKey ? 1 : 2} })
+            expect(a).to.eql({ 1: 2 });
         })
 
         it('option.filter', function() {
@@ -81,6 +84,14 @@ describe('单元测试', function() {
             expect(a).to.eql('a=1&b=2&c=3&d=4');
         });
 
+        it('addQueryPrefix', function() {
+            var a = stringify({ a: '1'});
+            expect(a).to.eql('a=1');
+
+            var a = stringify({ a: '1'}, { addQueryPrefix: true });
+            expect(a).to.eql('?a=1');
+        });
+
         it('option', function() {
             var a = stringify({ a: '1', b: '2', c: '3'}, {sep: '+', eq: ':'});
             expect(a).to.eql('a:1+b:2+c:3');
@@ -92,6 +103,9 @@ describe('单元测试', function() {
 
             var a = stringify({ a: '='}, { encode: function (x) {return x} })
             expect(a).to.eql('a==');
+
+            var a = stringify({ a: '='}, { encode: function (x, isKey) {return isKey ? 1 : 2} })
+            expect(a).to.eql('1=2');
         })
 
         it('option.filter', function() {