# @arkstack/filesystem 中文文档

规范地址：https://npmcn.com/package/%40arkstack/filesystem/

版本：0\.22\.2
npm 元数据更新时间：2026-11-07T13:59:30.741Z
中文译文更新时间：2026-11-06T19:41:00.335Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40arkstack/filesystem
原文对照：https://npmcn.com/package/%40arkstack/filesystem/?lang=original
项目主页：https://arkstack.toneflix.net/
源码仓库：https://github.com/arkstack-hq/arkstack

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

- 包体积（解压后）：39.3 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：8 个
- peer 依赖：@h3ravel/musket ^2\.2\.13
- 首次发布：2026-03-19T16:02:33.119Z
- 最新版本发布：2026-11-07T13:59:30.544Z
- 近 30 天下载量：3250（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：208（近 12 个月 208 个）

## 中文简介

Arkstack 的文件系统模块,为框架提供共享文件存储和文件系统实用化.

## 安装

```sh
npm install @arkstack/filesystem
```

也可以使用：`pnpm add @arkstack/filesystem`、`yarn add @arkstack/filesystem`、`bun add @arkstack/filesystem`

## README

# @ arkstack/ 文件系统

[![@arkstack/filesystem](https://img.shields.io/npm/dt/@arkstack/filesystem?style=flat-square&label=@arkstack/filesystem&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F@arkstack/filesystem)](https://www.npmjs.com/package/@arkstack/filesystem)

Arkstack 的文件系统模块,为框架提供共享文件存储和文件系统实用化.

## 自定义驱动程序

@ arkstack/ filesystem 允许您配置并使用自定义的存储驱动程序 .

**Cloudinary FileDriver.ts (英语)**

```ts
import type { DriverContract, ObjectVisibility } from 'flydrive/types'
import type { CustomDiskConfig } from '@arkstack/filesystem'

export class CloudinaryFileDriver implements DriverContract {
  constructor(private config?: CustomDiskConfig) {}
  async exists(key: string) {}
  async get(key: string) {}
  async getStream(key: string) {}
  async getBytes(key: string) {}
  async getMetaData(key: string) {}
  async getVisibility(): Promise<ObjectVisibility> {}
  async getUrl(key: string) {}
  async getSignedUrl(key: string) {}
  async getSignedUploadUrl(key: string) {}
  async setVisibility() {}
  async put() {}
  async putStream() {}
  async copy() {}
  async move() {}
  async delete() {}
  async deleteAll() {}
  async listAll() {}
  async bucket() {}
}
```

**sc/配置/文件系统.ts**

```ts
import { CloudinaryFileDriver } from '../CloudinaryFileDriver'
export default () => {
  return {
    default: 'images',
    disks: {
      images: {
        //...Other Disks Here
        driver: 'cloudinary',
      },
    },
    links: {},
    custom_drivers: {
      cloudinary: CloudinaryFileDriver,
    },
  }
}
```

为了改进型号安全和自动完成,您可以增加 `CustomDiskDriverRegistry`

**d.t.节**

```ts
declare module '@arkstack/filesystem' {
  interface CustomDiskDriverRegistry {
    cloudinary: { cloud_name: string; api_key: string; api_secret: string }
  }
}
```

## 常见问题

### @arkstack/filesystem 是什么？

Arkstack 的文件系统模块,为框架提供共享文件存储和文件系统实用化\.

### 如何安装 @arkstack/filesystem？

在项目目录运行 npm install @arkstack/filesystem，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@h3ravel/musket（^2\.2\.13）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @arkstack/filesystem 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/arkstack\_\_filesystem 是否存在。

### @arkstack/filesystem 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @arkstack/filesystem 可以商用吗？

@arkstack/filesystem 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @arkstack/filesystem 的下载量有多少？

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

### @arkstack/filesystem 还在维护吗？

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