# @coara/nestjs-aws-s3-manager

> Aws s3 manager for nestjs

Latest version **11.1.1** (published 2025-10-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @coara/nestjs-aws-s3-manager
pnpm add @coara/nestjs-aws-s3-manager
yarn add @coara/nestjs-aws-s3-manager
bun add @coara/nestjs-aws-s3-manager
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 11.1.1 |
| Published | 2025-10-03 |
| First published | 2019-10-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 284.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Coara |
| Maintainers | miquelferrerllompart, francescjaume, josepmorey, cuni0716, amagraner, javip-dev, adrianfernandezalv |

## Links

- npm: https://www.npmjs.com/package/@coara/nestjs-aws-s3-manager
- Repository: https://github.com/coaraco/nestjs-aws-s3-manager
- Homepage: https://github.com/coaraco/nestjs-aws-s3-manager#readme
- Issues: https://github.com/coaraco/nestjs-aws-s3-manager/issues
- npm.io page: https://npm.io/package/@coara/nestjs-aws-s3-manager

## Dependencies (4)

- [multer](https://npm.io/package/multer.md) ^2.0.2
- [multer-s3](https://npm.io/package/multer-s3.md) ^3.0.1
- [@nestjs/swagger](https://npm.io/package/@nestjs/swagger.md) ^11.2.0
- [@aws-sdk/client-s3](https://npm.io/package/@aws-sdk/client-s3.md) ^3.901.0

## Recent versions

- 11.1.1 (latest) — 2025-10-03
- 10.3.20 — 2025-04-30
- 10.3.19 — 2025-04-30
- 10.3.18 — 2025-04-30
- 10.3.17 — 2025-04-30
- 10.3.16 — 2025-04-28
- 10.3.15 — 2025-04-28
- 10.3.14 — 2025-04-28
- 10.3.13 — 2024-06-21
- 10.3.12 — 2024-06-21
- 10.3.11 — 2024-06-21
- 10.3.10 — 2024-06-21
- 10.3.9 — 2024-06-21
- 0.0.10 — 2022-11-10
- 0.0.9 — 2022-11-10
- … 9 more at https://npm.io/package/@coara/nestjs-aws-s3-manager/versions

## README

# Nestjs aws s3 manager

File manager module for NestJs.

### Installation

**Yarn**

```bash
yarn add @coara/nestjs-aws-s3-manager
```

**NPM**

```bash
npm install @coara/nestjs-aws-s3-manager --save
```

### Getting Started

Let's register the FileManagerModule in `app.module.ts`

```typescript
import { Module } from '@nestjs/common';
import { FileManagerModule } from '@coara/nestjs-aws-s3-manager';

@Module({
  imports: [
    FileManagerModule.forRoot({
      awsAccessKeyId: '****',
      awsSecretAccessKey: '****',
      awsBucketName: 'my-bucket-name',
    }),
  ],
})
export class AppModule {}
```

With Async

```typescript
import { Module } from '@nestjs/common';
import { FileManagerModule } from '@coara/nestjs-aws-s3-manager';

@Module({
  imports: [
    FileManagerModule.forRootAsync({
      useFactory: (configService: ConfigService) => ({
        awsAccessKeyId: configService.get('AWS_ACCESS_KEY_ID'),
        awsSecretAccessKey: configService.get('AWS_SECRET_ACCESS_KEY'),
        awsBucketName: 'my-bucket-name',
      }),
      inject: [ConfigService],
    }),
  ],
})
export class AppModule {}
```

### API Endpoints

```bash
curl -F 'file=@path/to/local/file' http://localhost:3000/images
```

That's it!

---
_Source: https://npm.io/package/@coara/nestjs-aws-s3-manager · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._