Nest.js MinIO Module

A simple Minio wrapper for Nest.js .

Installation

1npm i minio-nestjs 
2# or
3yarn add minio-nestjs

Module setup

Register module synchronously :

1import { Module } from '@nestjs/common';
2import { MinioModule } from 'minio-nestjs';
3
4@Module({
5  imports: [
6    MinioModule.register({
7      endPoint: '127.0.0.1',
8      port: 9000,
9      useSSL: false,
10      accessKey: 'biomousavi',
11      secretKey: 'yourStrongPassword',
12    }),
13  ],
14})
15export class AppModule {}

Asynchronous registration:

1import { Module } from '@nestjs/common';
2import { MinioModule } from 'minio-nestjs';
3import { ConfigModule, ConfigService } from '@nestjs/config';
4
5@Module({
6  imports: [
7    ConfigModule.forRoot({ envFilePath: '.env' }),
8    MinioModule.registerAsync({
9      isGlobal: true,
10      imports: [ConfigModule],
11      inject: [ConfigService],
12      useFactory: (configService: ConfigService) => {
13        return {
14          port: +configService.get('MINIO_PORT'),
15          endPoint: configService.get('MINIO_ENDPOINT'),
16          accessKey: configService.get('MINIO_ROOT_USER'),
17          secretKey: configService.get('MINIO_ROOT_PASSWORD'),
18          useSSL: configService.get('NODE_ENV') === 'production' ? true : false,
19        };
20      },
21    }),
22  ],
23})
24export class AppModule {}

Module usage

Now you have access to Minio client:

1import { Injectable } from '@nestjs/common';
2import { MinioService } from 'minio-nestjs';
3
4@Injectable()
5export class FileService {
6  constructor(private readonly minioService: MinioService) {}
7
8  async getBuckets() {
9    return await this.minioService.listBuckets();
10  }
11}