# @getlarge/nestjs-tools-file-storage 中文文档

规范地址：https://npmcn.com/package/%40getlarge/nestjs-tools-file-storage/

版本：1\.4\.3
npm 元数据更新时间：2026-04-08T10:59:16.934Z
中文译文更新时间：2026-11-16T06:18:24.096Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40getlarge/nestjs-tools-file-storage
原文对照：https://npmcn.com/package/%40getlarge/nestjs-tools-file-storage/?lang=original
项目主页：https://github.com/getlarge/nestjs-tools/tree/main/packages/file-storage

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

- 包体积（解压后）：124 kB，48 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@aws-sdk/client-s3 3，@aws-sdk/lib-storage 3，@google-cloud/storage 7，@nestjs/common ^10 \|\| ^11
- 首次发布：2024-04-16T20:35:43.369Z
- 最新版本发布：2026-04-08T10:59:16.824Z
- 近 30 天下载量：6928（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 1 个）

## 中文简介

文件存储

## 安装

```sh
npm install @getlarge/nestjs-tools-file-storage
```

也可以使用：`pnpm add @getlarge/nestjs-tools-file-storage`、`yarn add @getlarge/nestjs-tools-file-storage`、`bun add @getlarge/nestjs-tools-file-storage`

## README

# 文件存储

[![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-file-storage.svg?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-file-storage)

这个模块提供了一个统一的API,用于存储文件在不同存储提供者中.

过期后端 :

-   [节点文件系统](https://npmcn.com/package/%40getlarge/nestjs-tools-file-storage/src/lib/file-storage-fs.class.ts)
-   [AWS S3 导弹](https://npmcn.com/package/%40getlarge/nestjs-tools-file-storage/src/lib/file-storage-s3.class.ts)
-   [谷歌云存储](https://npmcn.com/package/%40getlarge/nestjs-tools-file-storage/src/lib/file-storage-google.class.ts)

## 安装

```bash
npm install --save @getlarge/nestjs-tools-file-storage
```

## 示例

```ts
// module.ts
import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { FileStorageLocal, FileStorageModule, FileStorageS3 } from '@getlarge/nestjs-tools-file-storage';

import { AppService } from './env';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
    }),
    FileStorageModule.forRootAsync({
      inject: [ConfigService],
      useFactory: (configService: ConfigService) => {
        const environment = configService.get('NODE_ENV', { infer: true });
        if (environment === 'development') {
          const setup = {
            storagePath: configService.get('STORAGE_PATH'),
            maxPayloadSize: configService.get('MAX_PAYLOAD_SIZE'),
          };
          return new FileStorageLocal(setup);
        }
        const setup = {
          maxPayloadSize: configService.get('MAX_PAYLOAD_SIZE'),
          bucket: configService.get('AWS_S3_BUCKET'),
          region: configService.get('AWS_S3_REGION'),
          credentials: {
            accessKeyId: configService.get('AWS_S3_ACCESS_KEY_ID'),
            secretAccessKey: configService.get('AWS_S3_SECRET_ACCESS_KEY'),
          },
        };
        return new FileStorageS3(setup);
      },
    }),
  ],
  providers: [AppService],
})
export class AppModule {}
```

```ts
// service.ts
import { FileStorageService } from '@getlarge/nestjs-tools-file-storage';
import { Inject, Injectable, Logger } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';

@Injectable()
export class AppService {
  constructor(
    @Inject(ConfigService) private readonly configService: ConfigService,
    @Inject(FileStorageService)
    private readonly fileStorageService: FileStorageService,
  ) {}

  getFile(filePath: string): Promise<Buffer> {
    return this.fileStorage.downloadFile({ filePath });
  }

  setFile(filePath: string, content: string): Promise<void> {
    return this.fileStorage.uploadFile({
      filePath,
      content,
    });
  }

  deleteFile(filePath: string): Promise<void> {
    return this.fileStorage.deleteFile({ filePath });
  }
}
```

## 测试

要进行测试,你需要一个 `.env.test` 在工程的根中,按照工程的结构 `.env.test.sample` 文档. 您也可通过外部服务认证.

### 自动取款机

我强烈建议配置 [AWS 身份识别中心](https://docs.aws.amazon.com/singlesignon/latest/userguide/quick-start-default-idc.html) 管理您的 AWS 证书用于开发.

> **说明:** 你可以用这个 `aws` 要认证的 CLI 信息 [这里](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html/)。 。 。 .

经认证的:

-   设置 `AWS_PROFILE` 要使用配置文件的环境变量
-   或设置 `AWS_S3_ACCESS_KEY_ID` 财务报告和审定财务报表 `AWS_S3_SECRET_ACCESS_KEY` 环境变量.

### 谷歌云号

建议采取的办法是: [应用程序默认证书](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev)。 。 。 .

> **说明:** 你可以用这个 `gcloud` 用于认证的 CLI 更多信息 [这里](https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login)。 。 。 .

## 解决问题

如果在升级后获得以下错误:

```sh
/usr/local/bin/node[57897]: ../src/node_http_parser.cc:517:static void node::(anonymous namespace)::Parser::Execute(const FunctionCallbackInfo<v8::Value> &): Assertion `parser->current_buffer_.IsEmpty()' failed.
```

你需要更新到节点v18.6或更高. 是因为节点有问题 `http` 模块. 更多信息可以找到 [这里](https://github.com/nodejs/node/issues/39671) 财务报告和审定财务报表 [这里](https://github.com/aws/aws-sdk-js-v3/issues/2843)。 。 。 .

## 常见问题

### @getlarge/nestjs-tools-file-storage 是什么？

文件存储

### 如何安装 @getlarge/nestjs-tools-file-storage？

在项目目录运行 npm install @getlarge/nestjs-tools-file-storage，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@nestjs/common（^10 \|\| ^11）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @getlarge/nestjs-tools-file-storage 支持 TypeScript 吗？

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

### @getlarge/nestjs-tools-file-storage 支持 ESM 还是 CommonJS？

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

### @getlarge/nestjs-tools-file-storage 可以商用吗？

@getlarge/nestjs-tools-file-storage 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @getlarge/nestjs-tools-file-storage 的下载量有多少？

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

### @getlarge/nestjs-tools-file-storage 还在维护吗？

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

