Skip to content

Latest commit

 

History

History
875 lines (653 loc) · 26.4 KB

api.md

File metadata and controls

875 lines (653 loc) · 26.4 KB
Raw

文档

Utils.idcard

根据身份证号获取到一些个人信息

通过这个方式可以从身份证号中提取到这个人、生日、年龄和生肖

  • param {string} card 身份证号

例子🌰

import { Idcard } from 'better-js-lib';
var idcard = new Idcard('110102199901018781');
/*
  {
    birthday: {
      birthday: "1994/08/15",
      year: "1994",
      month: "08",
      day: "15"
    },
    age: '24',
    sex: '男',
    animalSigns: '狗'
  }
*/

idcard.IDCard15To18('131002940815361'); // 131002199408153611
idcard.getAge('131002199408153611'); // '24'
idcard.getAge('131002199408153611', 1554090947763); // '24'，可以通过设置第二个参数改变对比年龄的基准时间
idcard.getAnimalSigns('131002199408153611'); // '狗'
idcard.getBirthday('131002199408153611');
/*
{
  birthday: "1994/08/15",
  year: "1994",
  month: "08",
  day: "15"
}
*/

可以通过 idcard 方法获取身份证号相关的全部信息，也可以通过单独的方法获取指定信息

注：如果传入身份证号的格式不对，以上方法统一返回数字 -1；请用 -1 判断身份证格式是否合法，没必要在获取身份证号信息之前自己写方法校验是否合法

🔝

Utils.is

判断 JavaScript 类型的校验库，可用于判断数据类型等

general

  • is.a (value, type) 或者 is.type (value, type) - 通过原生 typeof 校验数据类型
  • is.getType (value) - 获取 value 的数据类型
  • is.defined (value) - 校验 value 是否有定义
  • is.empty (value) - 校验 value 是否为空，这里的"空"包括 !!value === false、[]、{}
  • is.empty2 (value) - 校验 value 是否为空，这里的"空"包括 null、undefined、''
  • is.emptyObj (value) - 校验 value 是否为空对象
  • is.equal (value, other) - 校验 value 和 other 是否相等，包括基本数据类型、函数、日期、数组、对象的深层对比
  • is.hosted (value, host) - 校验 对象 hosted 的属性 value 是否是 hosted(包括除基本数据类型之外的对象数据类型)
  • is.instance (value, constructor) - 校验 value 是否是 constructor 的实例化对象
  • is.nil (value) - 校验 value 的数据类型是否是 null
  • is.undef (value) - 校验 value 的数据类型是否是 undefined

arguments

  • is.args (value) - 校验 value 的数据类型是否是参数数组
  • is['args-empty'] (value) - 校验 value 是否是一个空的参数数组

array

  • is.array (value) - 校验 value 的数据类型是否是数组
  • is['array-empty'] (value) - 校验 value 是否是一个空的数组
  • is.arraylike (value) - 校验 value 是否是一个类数组

boolean

  • is.bool (value) - 校验 value 的数据类型是否是布尔类型

date

  • is.date (value) - 校验 value 的数据类型是否是日期类型

element

  • is.element (value) - 校验 value 是否是一个 HTML 元素节点

error

  • is.error (value) - 校验 value 的数据类型是否是 Error

function

  • is.fn (value) - 校验 value 的数据类型是否是函数类型(包括 Function、GeneratorFunction、AsyncFunction)

number

  • is.number (value) - 校验 value 的数据类型是否是数字
  • is.infinite (value) - 校验 value 是否为无穷大
  • is.decimal (value) - 校验 value 是否为小数
  • is.divisibleBy (value, n) - 校验 value 是否可以被整除
  • is.integer (value) - 校验 value 是否为整数
  • is.maximum (value, others) - 判断 value 是否是 others数组中最大的
  • is.minimum (value, others) - 判断 value 是否是 others数组中最小的
  • is.nan (value) - 判断 value 是否是 NaN
  • is.even (value) - 判断 value 是否是偶数
  • is.odd (value) - 判断 value 是否是奇数
  • is.ge (value, other) - 判断 value 是否大于或等于 other
  • is.gt (value, other) - 判断 value 是否大于 other
  • is.le (value, other) - 判断 value 是否小于或等于 other
  • is.lt (value, other) - 判断 value 是否小于 other
  • is.within (value, start, finish) - 判断 value 是否位于 [start, finish] 区间内

object

  • is.object (value) - 校验 value 的数据类型是否是对象

regexp

  • is.regexp (value) - 校验 value 的数据类型是否是正则表达式

string

  • is.string (value) - 校验 value 的数据类型是否是字符串

encoded binary

  • is.base64 (value) - 校验 value 是否是一个 base64 编码的二进制数据
  • is.hex (value) - 校验 value 是否是一个十六进制数据

Symbols

  • is.symbol (value) - 校验 value 的数据类型是否是 symbol

BigInts

  • is.bigint (value) - 校验 value 的数据类型是否是 ES-提议的 bigint 类型

例子🌰

import { is } from 'better-js-lib';
is.string('123'); // true

🔝

Utils.exchangeTreeFieldName

全局替换树形结构数据的某个字段，并且在对应二级children数组上添加“全部”的选项

  • param {array} arr - 要处理的数组
  • param {string} newKey - 要替换成的 key
  • param {string} oldKey - 要被换成的 key
  • param {boolen} [isDelete] - 旧的 key 是否要被干掉
  • return {array} 返回处理之后的树形结构数据

例子🌰

import { exchangeTreeFieldName } from 'better-js-lib';
const arr = [
  {
    "dept_code":"001",
    "dept_name":"总部",
    "parent_dept_code":"",
    "type_level":0,
    "children":[
      {
        "dept_code":"CN02",
        "dept_name":"华东大区",
        "parent_dept_code":"001",
        "type_level":1,
        "children":[
          {
            "dept_code":"512Y",
            "dept_name":"苏州区部",
            "parent_dept_code":"CN02",
            "type_level":2,
            "children":[
              {
                "dept_code":"512A",
                "dept_name":"领秀江南经营分部",
                "parent_dept_code":"512Y",
                "type_level":3,
                "children":[
                  {
                    "dept_code":"512TG",
                    "dept_name":"干将东路速运营业点",
                    "parent_dept_code":"512A",
                    "type_level":4
                  }
                ]
              },
            ]
          }
        ]
      },
    ]
  }
];
exchangeTreeFieldName(arr, 'title', 'dept_name', false);
/*
[
  {
    "dept_code":"001",
    "dept_name":"总部",
    "title": '总部',
    "parent_dept_code":"",
    "type_level":0,
    "children":[
      {
        "dept_code":"CN02",
        "dept_name":"华东大区",
        "title":"华东大区",
        "parent_dept_code":"001",
        "type_level":1,
        "children":[
          {
            "dept_code":"512Y",
            "dept_name":"苏州区部",
            "title":"苏州区部",
            "parent_dept_code":"CN02",
            "type_level":2,
            "children":[
              {
                "dept_code":"512A",
                "dept_name":"领秀江南经营分部",
                "title":"领秀江南经营分部",
                "parent_dept_code":"512Y",
                "type_level":3,
                "children":[
                  {
                    "dept_code":"512TG",
                    "dept_name":"干将东路速运营业点",
                    "title":"干将东路速运营业点",
                    "parent_dept_code":"512A",
                    "type_level":4
                  }
                ]
              },
            ]
          }
        ]
      },
    ]
  }
];
*/

🔝

Utils.check

校验信息

这个方法集中了检验各类信息的函数

  • param {string} message 需要校验的信息
  • return {boolean} 校验结果

例子🌰

import { check } from 'better-js-lib';

/* 校验字符串是否都是中文 */
check.checkCnString('这是一段中文'); // true

/* 校验"身份证号"是否合法，只支持校验"18位"身份证 */
/* "15位"身份证号请通过 idcard.IDCard15To18 方法转成"18位"后再校验 */
check.checkIDCard('110102198401015378'); // true

/* 校验"邮箱"是否合法 */
check.checkMail('13888888888@163.com'); // true

/* 校验"手机号"是否合法 */
check.checkPhone('13888888888'); // true

/* 校验"手机， 座机， 分机号码"是否合法 */
check.checkTelephone('13888888888'); // true

🔝

Utils.getUrlQuery

获取 url 中的参数

  • param {string} [key] 需要获取的 key，如果不传改参数则返回 url 中的所有参数组成的对象
  • param {string} [url] 可以通过传入 url 参数来获取指定 url 的参数，不传则默认为 window.location.href
  • return {string|object|null} 返回对应 key 的 value，如果没有的话则返回 null

例子🌰

import { getUrlQuery } from 'better-js-lib';
// url: http://localhost?name=zhangsan&age=25&phone=13888888888
getUrlQuery();
/*
{
  name: "zhangsan",
  age: "25",
  phone: "13888888888"
}
*/

getUrlQuery('name'); // zhangsan
getUrlQuery('sex'); // null

支持获取带 hash 的 url 的参数 🔝

Utils.getUrlString

将对象转换为 url 地址后面可以携带的参数形式

  • param {object} obj 需要转换的对象
  • param {object} [config] 配置项
      • {boolean} hasPrefix 在首位增加"?"

例子🌰

import { getUrlString } from 'better-js-lib';
getUrlString({ name: "zhangsan", age: "25", phone: 13888888888 }); // name=zhangsan&age=25&phone=13888888888

getUrlString({ name: "zhangsan", age: "25", phone: 13888888888 }, { hasPrefix: true }); // ?name=zhangsan&age=25&phone=13888888888

getUrlString({ person: { name: "zhangsan", age: "25" }, auth: [1, 2, 3] }); // person={"name":"zhangsan","age":"25"}&auth=[1,2,3]

非原型数据类型的数据会做 JSON.stringify 处理

🔝

Utils.filterVoidObject

这个方法用来过滤对象中的空值

  • obj {Object} 待过滤object
  • isValid {Function} 自定义回调函数，返回有效的值
  • return {Object} 过滤后的object

例子🌰

import { filterVoidObject } from 'better-js-lib';
filterVoidObject({
  a: 1,
  b: null,
  c: undefined,
  d: '',
  e: '1'
});
/*
  {
    a: 1,
    e: '1'
  }
*/

🔝

Utils.isVoidObject

这个方法用来判断是否为空对象

  • param {Object} 待校验object
  • return {Boolean} 是否为空对象
import { isVoidObject } from 'better-js-lib';
isVoidObject({});
/* true */

isVoidObject({a: 1});
/* false */

isVoidObject('123'); // Error('参数类型非object')
/* false */

🔝

Utils.hasEmoji

这个方法用来校验字符串中是否含有 Emoji 表情符号

  • text {String} 进行校验的字符串
  • return {Boolean}是否含有表情符号

例子🌰

import { hasEmoji } from 'better-js-lib';
hasEmoji('Unicorn 🦄'); // true

hasEmoji('cat'); // false

🔝

Utils.getArrIntersection

取多个数组的交集

  • param {Array[Array,Array,...]} 内容为一个一个的数组
  • return {Array} 交集后的数组

例子🌰

import { getArrIntersection } from 'better-js-lib';
getArrIntersection([1, 2], [1, 2, 4, 5], [2, 4, 6]);
/* [2] */

getArrIntersection([1, 2], [1, 2, 4, 5], [3, 4, 6]);
/* [] */

🔝

Utils.NP

这个方法用来解决 JavaScript 中浮点数 加、减、乘、除中数字精度的问题

方法

NP.strip(num)                      // 获取离 num 最近的正确的数字
NP.plus(num1, num2, num3, ...)     // 加法，num + num2 + num3，至少传入两个数字
NP.minus(num1, num2, num3, ...)    // 减法，num - num2 - num3
NP.times(num1, num2, num3, ...)    // 乘法，num1 * num2 * num3
NP.divide(num1, num2, num3, ...)   // 除法，num1 / num2 / num3
NP.round(num, ratio)               // 为 num 保留 ratio 位小数

例子🌰

import { NP } from 'better-js-lib';
NP.strip(0.09999999999999998); // = 0.1
NP.plus(0.1, 0.2);             // = 0.3, not 0.30000000000000004
NP.plus(2.3, 2.4);             // = 4.7, not 4.699999999999999
NP.minus(1.0, 0.9);            // = 0.1, not 0.09999999999999998
NP.times(3, 0.3);              // = 0.9, not 0.8999999999999999
NP.times(0.362, 100);          // = 36.2, not 36.199999999999996
NP.divide(1.21, 1.1);          // = 1.1, not 1.0999999999999999
NP.round(0.105, 2);            // = 0.11, not 0.1

注：如果你不想得到这样的提示 XXX is beyond boundary when transfer to integer, the results may not be accurate，使用下面的方式想项目启动时关闭边界检查：

NP.enableBoundaryChecking(false); // default param is true

更多 API 请参考：number-precision

🔝

Utils.deepCopy

这个方法用来深拷贝数据，方法同 lodash.clonedeep，目前支持的数据类型：对象、数组、函数等

  • param {Any} 需要被深拷贝的数据
  • return {Any} 拷贝的新数据

例子🌰

import { deepCopy } from 'better-js-lib';
var obj = {
  key: {
    name: 'person'
  }
};

var obj_copy = deepCopy(obj);
obj_copy.key.name = 'person_copy';

obj.key.name; // 'person'

🔝

Utils.getPointsDistance

这个方法用来计算两个坐标点之间的直线距离

  • param {Number} [s_lat] 起始点纬度
  • param {Number} [s_lng] 起始点经度
  • param {Number} [e_lat] 终点纬度
  • param {Number} [e_lng] 终点经度
  • return {Number} 距离，单位为千米

例子🌰

import { getPointsDistance } from 'better-js-lib';
getPointsDistance(40, 166, 40, 167); // 118.1

🔝

Utils.exchangeCoordinates

这个方法用来转化坐标，以用于不同的坐标系

  • param {Object} [Coord] 坐标系，例如：{lng, lat}
  • param {String} [origin] 原坐标系格式，可选值：[gg:国标，bd：百度坐标]
  • param {String} [format] 要转成的格式，可选值：[gg:国标，bd：百度坐标]
  • return {Object} 转换后的坐标

例子🌰

import { exchangeCoordinates } from 'better-js-lib';
exchangeCoordinates({ lng: 123, lat: 45 }, 'bd', 'gg'); // { lng: 123, lat: 45 }

🔝

Utils.formatDate

这个方法集合了 “时间类” 的方法，引用 dayjs 时间库，因此用户也可以使用到所有的 dayjs 方法

Utils.formatDate.formatTimeNum

这个方法用来格式化时间的数字，输入小于 9 的数字将输出数字前面加 0 的字符串，大于 9 的数字直接变以字符串的形式输出

例子🌰

import { formatDate } from 'better-js-lib';
formatDate.formatTimeNum(6); // "06"
formatDate.formatTimeNum(12); // "12"

Utils.formatDate.format

这个方法用来格式化时间

  • param {String|Date} dateStr 可以解析传入的一个标准的ISO 8601时间字符串，或者是一个 Date 对象
  • param {String} formatVal 格式化模板，要格式化的形式
  • return {String} 格式化后时间

例子🌰

import { formatDate } from 'better-js-lib';
formatDate.format('2019-01-25', '[YYYY] YYYY-MM-DDTHH:mm:ssZ[Z]'); // 'YYYY 2019-01-25T00:00:00-02:00Z'

注：使用方法同 dayjs().format(String)，详情可参考 dayjs api

Utils.formatDate.formatSeconds

这个方法可以把秒转换成时分秒格式

  • param {Number} seconds 秒数
  • param {String} [formatVal] 格式化模板，默认是 'HH:mm:ss'
  • return {String} 时间

例子🌰

import { formatDate } from 'better-js-lib';
formatDate.formatSeconds('86399'); // 23:59:59
formatDate.formatSeconds('86399', 'mm:ss'); // 59:59

注：这个方法是从 "1970-01-01 00:00:00" 开始计算的，所以年月日的值没有意义

Utils.formatDate.getDayZeroTm

这个方法可以获取指定某一天零点时的时间戳

  • param {Number} dateStr 秒数
  • param {String} [unit] 单位，可选值["s":秒|"ms":"毫秒"|"":"dayjs对象"]
  • return {Number|Object} 时间戳或者 dayjs 对象

例子🌰

import { formatDate } from 'better-js-lib';
formatDate.getDayZeroTm('2019-01-01 08:00:00', 's'); // 1546272000
formatDate.getDayZeroTm('2019-01-01 08:00:00', 'ms'); // 1546272000000
formatDate.getDayZeroTm('2019-01-01 08:00:00'); // 同 dayjs(1546272000000) 返回的对象

Utils.formatDate.dayjs

这个方法用来获取一个 dayjs 对象

  • param {String|Date} dateStr 可以解析传入的一个标准的ISO 8601时间字符串，或者是一个 Date 对象
  • return {Object} dayjs 对象

例子🌰

import { formatDate } from 'better-js-lib';
formatDate.dayjs('2019-01-01 08:00:00'); // 同 dayjs('2019-01-01 08:00:00') 返回的对象

注：这个方法会返回一个 dayjs 对象，也就是说返回的对象也拥有 dayjs 中所有的方法

🔝

Utils.batchHandleObjectFields

对一个对象中指定字段进行批量处理

  • param {Object} [target] 目标对象
  • param {Array} [handleArr] 需要被处理的字段
  • param {Function} [format] 处理函数
  • return {Object} 处理后的对象

例子🌰

import { batchHandleObjectFields } from 'better-js-lib';
const data = {
  price01: 10000,
  price02: 10000,
  price03: 10000,
  value: '金额',
  obj: { value: '123' },
  arr: [1, 2, 3]
};
const processData = batchHandleObjectFields(data, ['price01', 'price02', 'price03'], (value) => value / 100);
/*
{
  price01: 100,
  price02: 100,
  price03: 100,
  value: '金额',
  obj: { value: '123' },
  arr: [1, 2, 3]
}
*/

注：目前此方法只支持处理值为 基本数据类型 的字段

🔝

Utils.exchangeObjectFieldName

替换一个对象中一些指定属性的属性名

  • param {Object} [obj] 目标对象
  • param {Array} [exchangeFields] 需要替换的对象属性名
  • return {Object} 处理后的对象

例子🌰

import { exchangeObjectFieldName } from 'better-js-lib';
const data = {
  price01: 10000,
  price02: 10000,
  price03: 10000,
  value: '金额',
  obj: { value: '123' },
  arr: [1, 2, 3]
};
const processData = exchangeObjectFieldName(data, [
  {
    oldName: 'price01',
    newName: 'newprice01'
  },
  {
    oldName: 'obj',
    newName: 'newobj',
    handler: (val) => {
      val.value = '456';
      return val;
    }
  }
]);
/*
{
  newprice01: 10000,
  price02: 10000,
  price03: 10000,
  value: '金额',
  newobj: { value: '456' },
  arr: [1, 2, 3]
}
*/

🔝

Utils.getScriptQuery

获取 package.json 的 scripts 中启动命令的指定参数值 比如从 npm run dev --proxy=mock 得到 proxy 的值为 mock

  • param {String} field 要获取的参数名
  • param {String} [defaultValue] 未获取到参数值，可设置一个默认值
  • return {String} 参数值，没有获取到并且没有设置默认值会返回 null

例子🌰

// npm run dev --proxy=mock
import { getScriptQuery } from 'better-js-lib';
getScriptQuery('proxy'); // mock
getScriptQuery('port'); // null

🔝

Utils.getNumberWithPrecision

将数字转为百分比格式

  • param {Number} value 要转换的数字
  • param {Number} [precision] 保留小数点后几位有效数字，默认为 2
  • param {Boolean} [needUnit] 保是否需要添加单位后缀，默认为 false
  • return {String} 转换后的百分比

例子🌰

import { getNumberWithPrecision } from 'better-js-lib';
getNumberWithPrecision(0.126); // '12.60'
getNumberWithPrecision(0.126, 1); // '12.6'
getNumberWithPrecision(0.126, 0); // '13'
getNumberWithPrecision(0.126, -1); // '0.126'
getNumberWithPrecision(0.126, undefined, true); // '12.60%'

🔝

Utils.GradientColor

根据首尾颜色和步长计算出渐变颜色的色值

  • param {Number} startRGB 起始颜色
  • param {Number} endRGB 结束颜色

方法

  • getColor 获取颜色值数组
    • param {Number} step 步长
    • return {string[]} 渐变颜色值数组

例子🌰

import { GradientColor } from 'better-js-lib';

const gradientColor = new GradientColor('#0057A0', '#90D5FF');

gradientColor.getColor(5);
// ['rgb(0,87,160)','rgb(29,112,179)', 'rgb(58,137,198)', 'rgb(86,163,217)', 'rgb(115,188,236)']

🔝