npm 包 auxilium-helpers 使用教程

auxilium-helpers 是一个常用的 npm 包，可以提供前端开发时常用的一些工具函数。这篇文章将介绍 auxilium-helpers 包的使用教程。

安装

尝试安装 auxilium-helpers 之前需要先安装 Node.js 和 npm，安装指令:

npm install auxilium-helpers --save

接下来在需要使用 auxilium-helpers 的 js 文件中引入即可:

import { HelperMethod } from 'auxilium-helpers';

常用函数

HelperMethod.getQueryParam

用于获取 URL 中的参数，在函数中需要传入两个参数，分别是参数名和 URL。函数返回的是参数值，如果 URL 中不存在该参数名，将会返回 null。

import { HelperMethod } from 'auxilium-helpers';

const URL = 'https://www.example.com?name=demo&age=18';

const name = HelperMethod.getQueryParam('name', URL);
const age = HelperMethod.getQueryParam('age', URL);
console.log(name); //demo
console.log(age);  //18

HelperMethod.sortArray

用于对数组进行排序，支持递增排序和递减排序。函数中需要传入两个参数，分别是要排序的数组和排序方式。可选的排序方式有：'asc'（递增）和 'desc'（递减）。

import { HelperMethod } from 'auxilium-helpers';

const arr = [3, 5, 2, 7, 1, 9, 11];
const sortedArr = HelperMethod.sortArray(arr, 'asc');
console.log(sortedArr); // [1, 2, 3, 5, 7, 9, 11]

HelperMethod.validateEmail

用于验证邮箱格式是否正确，函数中需要传入一个字符串，表示要验证的邮箱地址。函数根据邮箱地址的格式规则返回 true 或 false。

import { HelperMethod } from 'auxilium-helpers';

const email = 'example@example.com';
const isValid = HelperMethod.validateEmail(email);
console.log(isValid) // true

HelperMethod.validatePhone

用于验证手机号格式是否正确，函数中需要传入一个字符串，表示要验证的手机号码。函数根据手机号码的格式规则返回 true 或 false。

import { HelperMethod } from 'auxilium-helpers';

const phone = '13388888888';
const isValid = HelperMethod.validatePhone(phone);
console.log(isValid) // true

HelperMethod.throttle

用于函数节流的实现，函数中需要传入两个参数，分别是要节流的函数和超时时间（毫秒）。函数返回的是一个新函数，当调用该函数时，只有在超时时间过去后，才会再次触发原函数。

import { HelperMethod } from 'auxilium-helpers';

const onScroll = () => { console.log('scrolling...') };
const throttledOnScroll = HelperMethod.throttle(onScroll, 500);

window.addEventListener('scroll', throttledOnScroll);

总结

auxilium-helpers 包提供了常用的各种工具函数，例如获取 URL 中的参数、数组排序、邮箱格式验证、手机号格式验证以及函数节流等。这些函数对于前端开发非常实用，可以提高代码的开发效率。因此，建议前端开发者在项目中使用 auxilium-helpers 包来提升开发效率。

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