nscutils - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

lib/index.js

@@ -146,3 +146,3 @@ 'use strict';
          * @param {Boolean} fill  如果小数位长度不足是否需要补齐 default =true
-         * @returns {Number} 转换后的值
+         * @returns {String} 转换后的值
          */
@@ -172,3 +172,3 @@
          * @param {String} val  要操作的字符串
-         * @returns {Number} 删除前后空格后的字符串
+         * @returns {String} 删除前后空格后的字符串
          */
@@ -175,0 +175,0 @@

package.json

 {
   "name": "nscutils",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "some utils",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -1,2 +0,2 @@
-## Usage
+# Usage
 
@@ -13,4 +13,6 @@ Install with npm
 
-the utils for Array
+## the utils for Array
 
+### sort
+
 ```javascript
@@ -26,3 +28,155 @@ var Utils = require('nscutils');
  */
-Utils.Array.order(array, type, column);
+const res = Utils.Array.order(array, type, column);
 ```
+
+### de-duplication
+
+```javascript
+var Utils = require('nscutils');
+/**
+ * @example utils.Array.unique([{name:'zs'},{name:'zs'}],'name')
+ * @example utils.Array.unique([10,10])
+ * @param {Array} array
+ * @param {String} column
+ * @returns {Array}
+ */
+const res = Utils.Array.unique(array, column);
+```
+
+## the utils for String
+
+### removeHTML
+
+```javascript
+var Utils = require('nscutils');
+/**
+ * @param {String} html
+ * @returns {String}
+ * @example 'string'=Utils.String.removeHTML(`<span class="gray7 mr20">string</span>`)
+ */
+const res = Utils.String.removeHTML(html);
+```
+
+### cut off string and append in the end
+
+```javascript
+var Utils = require('nscutils');
+/**
+ *  subString(`sadfsdafsd`,2,'...')
+ * @param {String} val
+ * @param {Number} len
+ * @param {String} suffix
+ * @example 'sa...'=Utils.String.subString(`sadfsdafsd`,2,'...')
+ * @returns {String}
+ */
+const res = Utils.String.subString(val, len, suffix);
+```
+
+### String->Float
+
+```javascript
+var Utils = require('nscutils');
+/**
+ * @param {String} val
+ * @param {Number} len  decimal length
+ * @param {Boolean} fill   default =true
+ * @returns {String}
+ * @example '1.20'=Utils.String.toFixed('1.2',2)
+ * @example '1.2'=Utils.String.toFixed('1.2',2,false)
+ */
+const res = Utils.String.toFixed(val, len, fill);
+```
+
+### delete f&p space
+
+```javascript
+var Utils = require('nscutils');
+/**
+ * @param {String} val
+ * @returns {String}
+ * @example "das das"=nscutils.String.trim(`   das das  `)
+ */
+const res = Utils.String.trim(val);
+```
+
+### replaceAll
+
+```javascript
+var Utils = require('nscutils');
+/**
+ * @param {String} val
+ * @param {String} replacestr
+ * @param {String} newstr
+ * @returns {String}
+ * @example "a|aa|aa"=nscutils.String.replaceAll(`asaasaa`,'s','|')
+ */
+const res = Utils.String.replaceAll(val, replacestr, newstr);
+```
+
+### String->Date
+
+```javascript
+var Utils = require('nscutils');
+/**
+ * @param {String} val
+ * @param {String} split  '-'|'/'|... required default '-'
+ * @returns {Date}
+ * @example nscutils.String.toDate(`2015-01-01`,'-')
+ */
+const res = Utils.String.toDate(val, split);
+```
+
+## the utils for Date
+
+### format
+
+```javascript
+var Utils = require('nscutils');
+/**
+ * @param {Date} date
+ * @param {String} fmt   yyyy-MM-dd
+ * "y+":year
+ * "M+":month
+ * "q+":quarter
+ * "d+": day
+ * "h+": hour
+ * "m+": minute
+ * "s+":second
+ * "S": Millisecond
+ * @returns {String}
+ * @example "2018-11-14"=nscutils.Date.format(new Date(),'yyyy-MM-dd')
+ */
+const res = Utils.Date.format(date, fmt);
+```
+
+## the utils for Object/Array
+
+### copy
+
+```javascript
+var Utils = require('nscutils');
+/**
+ * @param {Boolean} isDeep
+ * @param {Object/Array} target
+ * @param {Object/Array} src  one or more Object
+ * @returns {Object/Array}
+ * @example {a:1,b:2,d:4,f:5}=nscutils.Object.extend(true,{},{a:1,b:2},{d:4},{f:5})
+ * also worked in Array
+ * @example [4,1,5,4]nscutils.Object.extend(true,[],[1,2,3,4],[4,1,5])
+ * @example [1,2,3,4]nscutils.Object.extend(true,[],[1,2,3,4])
+ */
+const res = Utils.Object.extend(isDeep,target,src...);
+```
+
+## the utils for color
+
+### rgb->binary
+
+```javascript
+var Utils = require('nscutils');
+/**
+ * @param {String} color
+ * @returns {String}
+ */
+const res = Utils.Color.rgb2binary(color);
+```

No alert changes

Improved metrics

Total package byte prevSize

36755

10.18%

Number of lines in readme file

181

570.37%

No dependency changes