# @flypeng/tool 中文文档

规范地址：https://npmcn.com/package/%40flypeng/tool/

版本：5\.7\.5
npm 元数据更新时间：2025-08-08T09:48:07.241Z
中文译文更新时间：2026-11-15T02:59:25.030Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40flypeng/tool
原文对照：https://npmcn.com/package/%40flypeng/tool/?lang=original
项目主页：https://github.com/flingyp/flypeng-tool#readme
源码仓库：https://github.com/flingyp/flypeng-tool

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：209 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2022-07-23T04:48:05.327Z
- 最新版本发布：2025-08-08T09:48:07.046Z
- 近 30 天下载量：12466（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 0 个）

## 中文简介

整合各种共同工具和方法

## 安装

```sh
npm install @flypeng/tool
```

也可以使用：`pnpm add @flypeng/tool`、`yarn add @flypeng/tool`、`bun add @flypeng/tool`

## README

# @flypeng/tool

![@flypeng/tool](https://img.shields.io/npm/v/%40flypeng%2Ftool?style=plastic&logo=npm&label=%40flypeng%2Ftool&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40flypeng%2Ftool)

## ⛳ Introduction

[@flypeng/tool](https://flingyp.github.io/flypeng-tool/) 是一个集成业务中常用的工具函数库。集成封装常用业务函数库，可以极大程度上的提高开发者的效率。

搭建这么一个函数库的灵感来自于 [VueUse](https://vueuse.org/)，把每一个工具函数想象成为一个钩子函数去使用。目标就是集成所有常用的工具函数，并且可以轻松使用它。

## 📦 Installation

```bash
npm install @flypeng/tool@latest

yarn add @flypeng/tool@latest

pnpm add @flypeng/tool@latest
```

## 📚 Usage

### `@flypeng/tool/browser`

集成所有非 `Node Functions` 环境下的工具函数

```ts
import { useRandomInteger, useIsMobile } from '@flypeng/tool/browser';

const randomInteger = useRandomInteger(10, 100); // Integer in [10, 100]
```

### `@flypeng/tool/node`

集成 Node 环境下的工具函数

```ts
import { useGetCurrentPath, useIsFile } from '@flypeng/tool/node';

const isFile = useIsFile(useGetCurrentPath()); // isFile is Boolean
```

## ⛏️ Typescript

使用 Typescript 开发时，由于 `@flypeng/tool` 构建设计问题，需要在 `tsconfig.json` 文件中重新指定对应模块包 `browser`、`node` 的类型声明文件路径

```json
{
  "compilerOptions": {
    "paths": {
      "@flypeng/tool/browser": ["node_modules/@flypeng/tool/dist/browser"],
      "@flypeng/tool/node": ["node_modules/@flypeng/tool/dist/node"]
    }
  }
}
```

## License

[MIT](https://npmcn.com/package/%40flypeng/tool/LICENSE) License © 2022 [FlingYP](https://github.com/flingyp)

## 常见问题

### @flypeng/tool 是什么？

整合各种共同工具和方法

### 如何安装 @flypeng/tool？

在项目目录运行 npm install @flypeng/tool，或使用 pnpm add / yarn add / bun add。

### @flypeng/tool 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @flypeng/tool 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @flypeng/tool 可以商用吗？

@flypeng/tool 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @flypeng/tool 的下载量有多少？

根据 npm 官方下载统计，@flypeng/tool 在 2026/10/15 – 2026/11/13 这 30 天内被下载 12,466 次，日均约 416 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @flypeng/tool 还在维护吗？

最新版本 5\.7\.5 发布于 2025/08/08（1\.3 年前）；至今共发布 41 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/07/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。