@epilot/file-client
Client library for epilot File API
Uses openapi-client-axios
Installation
npm install --save @epilot/file-client
Usage
import fs from 'fs';
import { getClient } from '@epilot/file-client';
const fileClient = getClient();
// get upload params
const uploadFileRes = await fileClient.uploadFile(null, { filename: 'document.pdf', mime_type: 'application/pdf' });
const uploadParams = uploadFileRes.data;
// upload file to S3
const file = fs.readFileSync('./document.pdf')
const uploadRes = await fileClient.put(
uploadParams.upload_url,
file,
{ headers: { 'content-type': 'application/json' }}
);
// save file as an entity
const uploadParams = await fileClient.saveFile(
null,
{ s3ref: uploadParams.s3ref, access_control: 'private' },
);
Documentation
https://docs.epilot.io/docs/files/file-api
关于 @epilot/file-client 的常见问题
@epilot/file-client 是什么？
Client library for the epilot File API
如何安装 @epilot/file-client？
在项目目录运行 npm install @epilot/file-client，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：axios（^1.0.0 || >=0.25.0 <1.0.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
@epilot/file-client 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@epilot/file-client 支持 ESM 还是 CommonJS？
以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。
@epilot/file-client 可以商用吗？
@epilot/file-client 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@epilot/file-client 的下载量有多少？
根据 npm 官方下载统计，@epilot/file-client 在 2026/10/14 – 2026/11/12 这 30 天内被下载 23,194 次，日均约 773 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@epilot/file-client 还在维护吗？
最新版本 1.30.0 发布于 2026/10/21（23 天前）；至今共发布 79 个版本，其中过去 12 个月发布了 17 个；首次发布于 2021/11/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。