# @farseerdev/farseer-client 中文文档

规范地址：https://npmcn.com/package/%40farseerdev/farseer-client/

版本：1\.29\.0
npm 元数据更新时间：2026-11-10T11:19:52.898Z
中文译文更新时间：2026-11-14T10:47:24.057Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40farseerdev/farseer-client
原文对照：https://npmcn.com/package/%40farseerdev/farseer-client/?lang=original
项目主页：https://client-docs.farseer.io/

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

- 包体积（解压后）：5.4 MB，2221 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.17
- 运行依赖：10 个
- 首次发布：2026-10-13T15:12:01.277Z
- 最新版本发布：2026-11-10T11:19:52.623Z
- 近 30 天下载量：4703（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：54（近 12 个月 54 个）

## 中文简介

远地点的打字客户端

## 安装

```sh
npm install @farseerdev/farseer-client
```

也可以使用：`pnpm add @farseerdev/farseer-client`、`yarn add @farseerdev/farseer-client`、`bun add @farseerdev/farseer-client`

## README

# @ farseerdev/ arseer- 客户端

类型脚本客户端 [远视器](https://farseer.io/) API (英语). Farseer Apps使用它来读取和写入模型,运行进出口,并使用文件工作.

联合国 [https://client-docs.farseer.io 互联网档案馆的存檔,存档日期2011-12-21](https://client-docs.farseer.io/)

## 安装

```bash
npm install farseer-client@npm:@farseerdev/farseer-client
```

这将安装在名称下的软件包 `farseer-client`,这就是 Farseer Apps 如何导入它。 由 Farseer CLI 创建的 Farseer App 文件夹已经拥有了 .

这个 `xlsx` 依赖性安装自 `cdn.sheetjs.com`,而不是从 npm. pnpm 11 默认拒绝这种依赖性(`ERR_PNPM_EXOTIC_SUBDEP`因此设置 `blockExoticSubdeps` 改为 `false`屏蔽的网络 `cdn.sheetjs.com` 无法安装软件包.

## 使用

```ts
import { FarseerClient, User, handleUnknownError } from 'farseer-client';

async function main() {
    const client = new FarseerClient();
    const users: User[] = await client.users.list();
}

main().catch(handleUnknownError);
```

`handleUnknownError` 打印失败请求的状态和正文,并结束脚本.

在 Farseer App 内,客户端从环境变量读取其设置 `TENANT_ID`, (中文(简体) ), `FARSEER_URL` 财务报告和审定财务报表 `FARSEER_API_KEY`任何其它地方,通过他们:

```ts
const client = new FarseerClient('<tenant ID>', '<API key>', 'https://<your-company>.farseer.io');
```

API密钥属于服务用户:在Farseer中,开放用户组,选择创建服务用户,并复制其显示的密钥. 租户身份证是租户的名字,列在用户菜单Switch租户之下.

## 常见问题

### @farseerdev/farseer-client 是什么？

远地点的打字客户端

### 如何安装 @farseerdev/farseer-client？

在项目目录运行 npm install @farseerdev/farseer-client，或使用 pnpm add / yarn add / bun add。

### @farseerdev/farseer-client 支持 TypeScript 吗？

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

### @farseerdev/farseer-client 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @farseerdev/farseer-client 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.17。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @farseerdev/farseer-client 可以商用吗？

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

### @farseerdev/farseer-client 的下载量有多少？

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

### @farseerdev/farseer-client 还在维护吗？

最新版本 1\.29\.0 发布于 2026/11/10（4 天前）；至今共发布 54 个版本，其中过去 12 个月发布了 54 个；首次发布于 2026/10/13。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。