# @svtslv/nestjs-minio

> Nest - modern, fast, powerful node.js web framework (@minio)

Latest version **1.0.1** (published 2020-04-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @svtslv/nestjs-minio
pnpm add @svtslv/nestjs-minio
yarn add @svtslv/nestjs-minio
bun add @svtslv/nestjs-minio
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-04-04 |
| First published | 2020-03-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Sviatoslav H |
| Maintainers | svtslv |
| Keywords | nest, nestjs, minio, s3, storage |

## Links

- npm: https://www.npmjs.com/package/@svtslv/nestjs-minio
- Repository: https://github.com/svtslv/nestjs-minio
- Homepage: https://github.com/svtslv/nestjs-minio#readme
- Issues: https://github.com/svtslv/nestjs-minio/issues
- npm.io page: https://npm.io/package/@svtslv/nestjs-minio

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2020-04-04
- 1.0.0 — 2020-03-19
- 0.1.1 — 2020-03-18
- 0.1.0 — 2020-03-16
- 0.0.1 — 2020-03-12

## README

# NestJS Minio

<a href="https://www.npmjs.com/package/@svtslv/nestjs-minio"><img src="https://img.shields.io/npm/v/@svtslv/nestjs-minio" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/package/@svtslv/nestjs-minio"><img src="https://img.shields.io/npm/l/@svtslv/nestjs-minio" alt="Package License" /></a>

## Table of Contents

- [Description](#description)
- [Installation](#installation)
- [Examples](#examples)
- [License](#license)

## Description
Integrates Minio with Nest

## Installation

```bash
npm install @svtslv/minio minio
```

```bash
npm install -D @types/minio
```

You can also use the interactive CLI

```sh
npx nestjs-modules
```

## Examples

```bash
docker run \
-p 9000:9000 \
-e MINIO_ACCESS_KEY=minio \
-e MINIO_SECRET_KEY=password \
minio/minio server /data
```

### MinioModule.forRoot(options, connection?)

```ts
import { Module } from '@nestjs/common';
import { MinioModule } from '@svtslv/nestjs-minio';
import { AppController } from './app.controller';

@Module({
  imports: [
    MinioModule.forRoot({
      config: {
        // url: 'http://minio:password@localhost:9000',
        accessKey: 'minio',
        secretKey: 'password',
        endPoint: 'localhost',
        port: 9000,
        useSSL: false,
      },
    }),
  ],
  controllers: [AppController],
})
export class AppModule {}
```

### MinioModule.forRootAsync(options, connection?)

```ts
import { Module } from '@nestjs/common';
import { MinioModule } from '@svtslv/nestjs-minio';
import { AppController } from './app.controller';

@Module({
  imports: [
    MinioModule.forRootAsync({
      useFactory: () => ({
        config: {
          // url: 'http://minio:password@localhost:9000',
          accessKey: 'minio',
          secretKey: 'password',
          endPoint: 'localhost',
          port: 9000,
          useSSL: false,
        },
      }),
    }),
  ],
  controllers: [AppController],
})
export class AppModule {}
```

### InjectMinioClient(connection?)

```ts
import { Controller, Get, } from '@nestjs/common';
import { InjectMinioClient, MinioClient } from '@svtslv/nestjs-minio';

@Controller()
export class AppController {
  constructor(
    @InjectMinioClient() private readonly minioClient: MinioClient,
  ) {}

  @Get()
  async getHello() {
    if(!await this.minioClient.bucketExists('bucket2')) {
      await this.minioClient.makeBucket('bucket2', '');
    }

    return await this.minioClient.listBuckets()
  }
}
```

## License

MIT

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