简介
onboard-shared 是一个基于 onboard 前端组件库的补充包，提供了一些常见的工具类函数和样式，帮助前端开发者更加高效地编写代码。
本文将会提供 onboard-shared 的详细介绍和使用教程，包含向导式的指导以及示例代码，让读者能够快速上手并理解该 npm 包的应用价值。
安装
使用 npm 工具进行安装，命令如下：
npm install onboard-shared --save
其中，--save 参数表示将该 npm 包作为项目的依赖项进行保存。
使用指南
引入
在项目中使用 onboard-shared，需要先进行引入：
import {util} from 'onboard-shared';其中的 util 是 onboard-shared 包中的一个工具类。
工具类介绍
onboard-shared 包提供了以下常见的工具类函数：
util.getQueryString(name: string, url?: string)从 URL 中获取指定参数名称的值。
name参数表示需要获取的参数名称，url参数表示需要处理的 URL，默认为当前页面的 URL。util.parseTime(time: Date | number | string, cFormat?: string)将时间转换为指定格式的字符串。
time参数表示需要转换的时间，可以是Date类型，也可以是时间戳或日期字符串。cFormat参数为转换后的时间格式，默认为yyyy-MM-dd hh:mm:ss。util.throttle(func: Function, wait: number, options?: { leading?: boolean, trailing?: boolean })函数节流，将高频率执行的函数转换为低频率执行的函数。
func参数为需要进行节流的函数，wait参数为等待时间，单位为毫秒。options参数为可选参数，用于设置执行函数的条件。leading表示是否允许第一次就执行函数，默认为true，trailing表示是否允许一次执行多次函数，默认为true。util.urlJoin(url: string, params: object)将 URL 和参数进行拼接，返回新的 URL。
url参数为需要拼接的 URL，params参数为需要拼接的参数，以对象的形式传入。
除此之外，onboard-shared 还提供了一些常见的样式 css，包含基础布局与样式、各种组件的样式以及国际化字体图标等，详见 onboard-shared 的 Github 仓库。
示例代码
下面是一个引用 onboard-shared 包中 util 工具类的示例代码：
-- -------------------- ---- ------- ------ ------ ---- ----------------- --- --- - -------------------------------------------------- --- -- - ------------------------- ----- -- -- --- --- ---- - --------------------------- ----- -- -- ----- --- --------- - -------------- --- ------- - -------------------------- -- -- ---------- -------- -------- ------ - -------------------- - --------------------------------- ------------------- ------- -- -- -- ---- ---- --
总结
onboard-shared 是一个实用性强、易用性高的 npm 包，提供了一些常见的工具类函数和样式，方便前端开发者进行快速开发和编写代码。
本文介绍了 onboard-shared 包的详细内容，包括引入、工具类介绍、示例代码等，希望能够有助于读者深入理解该 npm 包的使用方法和应用场景。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055c0781e8991b448d9a62