Nestjs Minio Client

Minio client for NestJs.

Features

• Configure and connect to Minio instance

Installation

Yarn

1yarn add nestjs-minio-client
2yarn add -D @types/minio

NPM

1npm install nestjs-minio-client --save
2npm install @types/minio --save-dev

Getting Started

To use Minio client we need to register module for example in app.module.ts

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

If you are using the @nestjs/config package from nest, you can use the ConfigModule using the registerAsync() function to inject your environment variables like this in your custom module:

1import { Module } from '@nestjs/common';
2import { MinioModule } from 'nestjs-minio-client';
3import { ConfigModule, ConfigService } from '@nestjs/config';
4
5@Module({
6  imports: [
7    MinioModule.registerAsync({
8      imports: [ConfigModule],
9      inject: [ConfigService],
10      useFactory: (config: ConfigService) => {
11        return {
12          endPoint: config.get('MINIO_ENDPOINT'),
13          port: parseInt(config.get('MINIO_PORT')),
14          useSSL: false,
15          accessKey: config.get('MINIO_ACCESS_KEY'),
16          secretKey: config.get('MINIO_SECRET_KEY'),
17        };
18      },
19    }),
20  ],
21  providers: [MinioClientService],
22  exports: [MinioClientService],
23})
24export class MinioClientModule {}

After the registration connection to minio instance should be completed and ready for usage.

Example usage in service.

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

For full Client API see Minio Javascript SDK reference here

---