npm 包 @cardsgame/utils 使用教程

简介

@cardsgame/utils 是一个前端开发工具库，包含了一些常用的工具函数，帮助开发者简化代码，并提高代码的可复用性，该工具库已发布到 NPM 上，方便大家使用。

安装

使用 npm 可以非常方便地安装 @cardsgame/utils：

npm install @cardsgame/utils --save

使用

在你的项目中引入需要的方法：

import { shuffle } from '@cardsgame/utils';

其中，shuffle 为需要引入的方法名，其他方法同理。

使用该库提供的方法：

let arr = [1, 2, 3, 4, 5];
shuffle(arr);
console.log(arr);  // [2, 1, 4, 5, 3]

API

@cardsgame/utils 提供了以下常用的工具函数：

shuffle(array: any[])

对数组进行随机排序

let arr = [1, 2, 3, 4, 5];
shuffle(arr);
console.log(arr);  // [2, 1, 4, 5, 3]

debounce(func: Function, wait: number)

节流函数，将连续触发的事件合并成一次去执行，wait 为延迟时间。

window.addEventListener('resize', debounce(handleResize, 500));

function handleResize() {
  console.log('触发 resize 事件');
}

throttle(func: Function, wait: number)

防抖函数，将高频率触发的事件延时执行，wait 为延迟时间。

window.addEventListener('scroll', throttle(handleScroll, 500));

function handleScroll() {
  console.log('触发 scroll 事件');
}

getQueryParams(url: string)

获取 URL 参数列表，返回一个对象。

let params = getQueryParams('http://localhost:3000?name=jack&age=18');
console.log(params);  // {name: 'jack', age: '18'}

parseQueryString(queryString: string)

将 URL 参数列表字符串解析成对象。

let params = parseQueryString('name=jack&age=18');
console.log(params);  // {name: 'jack', age: '18'}

formatMoney(value: number)

将数字格式化成千位分隔符数字字符串。

let result = formatMoney(1000000.12);
console.log(result);  // '1,000,000.12'

总结

@cardsgame/utils 提供了一些常用的工具函数，方便开发者在前端开发过程中更加便捷、高效的处理各种问题，可以极大的提高开发者的工作效率和代码质量，希望这篇文章对你有所帮助。

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