@flypeng/tool
v5.5.4
Published
Integrate a collection of common tools and methods
Downloads
5,232
Maintainers
Readme
@flypeng/tool
⛳ Introduction
@flypeng/tool 是一个集成业务中常用的工具函数库。集成封装常用业务函数库,可以极大程度上的提高开发者的效率。
搭建这么一个函数库的灵感来自于 VueUse,把每一个工具函数想象成为一个钩子函数去使用。目标就是集成所有常用的工具函数,并且可以轻松使用它。
📦 Installation
npm install @flypeng/tool@latest
yarn add @flypeng/tool@latest
pnpm add @flypeng/tool@latest
📚 Usage
@flypeng/tool/browser
集成所有非 Node Functions
环境下的工具函数
import { useRandomInteger, useIsMobile } from '@flypeng/tool/browser';
const randomInteger = useRandomInteger(10, 100); // Integer in [10, 100]
@flypeng/tool/node
集成 Node 环境下的工具函数
import { useGetCurrentPath, useIsFile } from '@flypeng/tool/node';
const isFile = useIsFile(useGetCurrentPath()); // isFile is Boolean
⛏️ Typescript
使用 Typescript 开发时,由于 @flypeng/tool
构建设计问题,需要在 tsconfig.json
文件中重新指定对应模块包 browser
、node
的类型声明文件路径
{
"compilerOptions": {
"paths": {
"@flypeng/tool/browser": ["node_modules/@flypeng/tool/dist/browser/index.d.ts"],
"@flypeng/tool/node": ["node_modules/@flypeng/tool/dist/node/index.d.ts"]
}
}
}