0.2.0

Author: yanhaijing

CHANGELOG.md

@@ -1,5 +1,9 @@
 # 变更日志
 
+## 0.2.0 / 2019-3-2
+
+- `stringify`新增`filter`和`convert`参数
+
 ## 0.1.0 / 2018-11-1
 
 - 添加 `parse()`

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.1.0-orange.svg)](https://www.npmjs.com/package/@jsmini/querystring)
+[![npm](https://img.shields.io/badge/npm-0.2.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")
 

config/.eslintrc.js

@@ -25,6 +25,7 @@ module.exports = {
             "error",
             "always"
         ],
-        "no-console": 0
+        "no-console": 0,
+        "no-unused-vars": 0,
     }
 };

doc/api.md

@@ -30,10 +30,26 @@ parse('a=1&b=2') // { a: 1, b: 2 }
 - param {string} [option.sep='&'] 参数分隔符
 - param {string} [option.eq='='] 参数赋值符
 - param {function} [option.encode=encodeURIComponent] 对参数进行编码的函数
+- param {function} [option.filter=(v, k) => true] 对数据进行过滤
+- param {function} [option.convert=(v, k) => /*undefined null -> ''*/] 对数据进行转换
 - return {string} 序列化字符串
 
 举个例子（要包含代码用例）
 
 ```js
 stringify({ a: 1, b: 2 }) // 'a=1&b=2'
 ```
+
+filter默认不过滤任何数据，但有时候想把空字符串过滤的话，会非常有用
+
+```js
+stringify({ a: null}) // 'a='
+stringify({ a: null}, {filter: v => v !== null }) // ''
+```
+
+convert用来对数据过滤，默认行为是将undefined和null转换为空字符
+
+```js
+stringify({ a: null}) // 'a='
+stringify({ a: null}, {convert: v => v }) // 'a=null'
+```

package.json

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

src/index.js

@@ -67,15 +67,19 @@ export function stringify(obj, option = {}) {
         sep: '&',
         eq: '=',
         encode: encodeURIComponent,
+        filter: (v, k) => true,
+        // undefined or null > ''
+        convert: (v, k) => typeof v === 'undefined' || v === null ? '' : v,
     }, option);
 
     let res = '';
 
     const isEncode = type(opt.encode) === 'function';
 
     for (let key in obj) {
-        if (hasOwnProp(obj, key)) {
-            const str = isPrimitive(obj[key]) ? String(obj[key]) : toString(obj[key]);
+        if (hasOwnProp(obj, key) && opt.filter(obj[key], key)) {
+            const val = opt.convert(obj[key], key);
+            const str = isPrimitive(val) ? String(val) : toString(val);
 
             const k = isEncode ? opt.encode(key) : key;
             const v = isEncode ? opt.encode(str) : str;