npm 包 oddish 使用教程

介绍

oddish 是一个基于 Node.js 的 npm 包，它提供了一些在前端开发中常用的实用方法和工具函数，如表格排序、表单验证、日期格式化等。通过 oddish 可以快速方便地引入这些工具函数，并大大提高前端开发效率。

安装

oddish 可以通过 npm 进行安装，直接在命令行输入以下命令即可：

npm install oddish --save

使用

安装完成后，在 js 文件中引入 oddish：

import * as oddish from 'oddish';

成功引入 oddish 后，您就可以使用其提供的所有函数了。下面我们详细介绍一些常用函数的用法。

表格排序

oddish 提供了一个 tableSort 函数，可以对表格进行排序。这个函数的使用方法如下：

let tableEl = document.querySelector('#table');
oddish.tableSort(tableEl, {
  columns: [0, 1],  // 排序列的索引
  asc: true,        // 是否升序排序
  dataType: 'string'// 列数据类型，'string', 'number' 或 'date'
});

其中，tableEl 是要进行排序的表格元素，columns 列出了需要排序的列的索引，asc 表示排序方式，默认是升序，dataType 表示列数据类型。

表单验证

表单验证是前端开发中经常需要使用的功能，oddish 也提供了一些常用的表单验证函数。比如，验证 email 的函数用法如下：

let email = 'test@example.com';
let isValidEmail = oddish.validEmail(email);

oddish 还提供了比较全面的表单验证函数，包括非空验证、手机号码验证、身份证号码验证等。

日期格式化

日期格式化是前端开发中另一个常用的功能，oddish 也提供了用于格式化日期的函数 dateFormat，使用方法如下：

let date = new Date();
let formattedDate = oddish.dateFormat(date, 'yyyy-MM-dd');

dateFormat 函数的第一个参数是一个 Date 对象，第二个参数是日期格式。oddish 支持的日期格式包括 'yyyy'、'MM'、'dd'、'hh'、'mm'、'ss' 等。您也可以自己定义日期格式，比如 'yyyy年MM月dd日 hh:mm:ss'。

总结

oddish 提供了一些常用的实用工具函数，可以大大提高前端开发效率。虽然 oddish 的文档比较简洁，但它的代码质量非常高，使用起来也很方便。

有了 oddish，我们可以更专注于业务逻辑的开发，而不需过多地关注工具函数的实现细节。我们建议前端开发人员都熟练使用这个工具包，从而更加高效地完成项目的开发。

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