npm 包 common-javascript-utils 使用教程

介绍

common-javascript-utils 是一个基于 JavaScript 的常用工具包，提供了一些常用的函数和方法，可以帮助前端开发人员更快地编写代码和解决常见问题。

该包提供了丰富的工具函数，例如时间格式化、字符串格式化、数组去重等等。使用 common-javascript-utils，可以有效地提高代码的效率和开发效率。

安装

使用 common-javascript-utils 只需要通过 npm 安装即可：

npm install common-javascript-utils

使用

使用 common-javascript-utils 很简单，只需要引入包并调用相应的功能函数即可：

const cjUtils = require('common-javascript-utils');

// 使用示例
console.log(cjUtils.formatDate(new Date()));

功能列表

1. formatDate(date, format)

格式化日期并返回格式化后的字符串。

参数：

• date：要格式化的日期对象（必选）
• format：格式化字符串（可选）

示例代码：

const cjUtils = require('common-javascript-utils');

// 格式化日期
console.log(cjUtils.formatDate(new Date(), 'yyyy-MM-dd hh:mm:ss.S'));
// 输出：2019-05-24 15:15:33.656

2. getRandom(min, max)

获取指定范围内的随机数。

参数：

• min：最小值（必选）
• max：最大值（必选）

示例代码：

const cjUtils = require('common-javascript-utils');

// 获取随机数
console.log(cjUtils.getRandom(1, 10));
// 输出：7

3. unique(array)

去除数组中的重复元素并返回处理后的新数组。

参数：

• array：要去重的数组（必选）

示例代码：

const cjUtils = require('common-javascript-utils');

// 去除数组中的重复元素
console.log(cjUtils.unique([1, 2, 3, 4, 4, 5, 5]));
// 输出：[1, 2, 3, 4, 5]

4. truncate(str, maxLength, suffix)

截断字符串并添加省略号。

参数：

• str：要截断的字符串（必选）
• maxLength：最大长度（必选）
• suffix：省略号字符串（可选，默认为 '...'）

示例代码：

const cjUtils = require('common-javascript-utils');

// 截断字符串
console.log(cjUtils.truncate('这是一段很长的字符串', 10));
// 输出：这是一段很...

5. isValidUrl(url)

判断是否是有效的 URL 地址。

参数：

• url：要判断的 URL 地址（必选）

示例代码：

const cjUtils = require('common-javascript-utils');

// 判断 URL 是否有效
console.log(cjUtils.isValidUrl('https://www.baidu.com'));
// 输出：true

6. queryStringToJSON(queryString)

将查询字符串转换为 JSON 对象。

参数：

• queryString：要转换的查询字符串（必选）

示例代码：

const cjUtils = require('common-javascript-utils');

// 将查询字符串转换为 JSON 对象
console.log(cjUtils.queryStringToJSON('?a=1&b=2&c=3'));
// 输出：{ a: '1', b: '2', c: '3' }

总结

common-javascript-utils 封装了多个常用的工具函数，可以方便地应用于项目开发中。在日常开发中，我们应该注意代码的复用性和规范性，使用这些工具函数可以有效地提高代码的效率和开发效率。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056be881e8991b448e5a1d