NestJS Minio Client

This is a really simple NestJS module, that lets you initialize the minio client in a NestJS friendly way and provides a handy way to inject the client.

Change Log

See Changelog for more information.

Authors

• Martin Andreev martin.andreev92@gmail.com

License

Licensed under the MIT License - see the LICENSE file for details.

Installation

To install the module simple run

1npm install minio-nestjs-client

or

1yarn add minio-nestjs-client

Usage

As this is a simple wrapper usage is pretty straigth forward. Just import the MinioModule and initialize it. There are two ways to do this, a simple config and async config.

To use the simple config just:

1import { MinioModule } from 'minio-nestjs-client';
2
3MinioModule.forRoot({
4  endPoint: 'play.min.io',
5  port: 9000,
6  useSSL: true,
7  accessKey: 'Q3AM3UQ867SPQQA43P2F',
8  secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
9});

However, there are times, where configuration if loaded from a service or depends on other providers. This can be achived using the MinioModule.forRootAsync.

1import { MinioModule } from 'minio-nestjs-client';
2
3MinioModule.forRootAsync({
4  useFactory: () =>
5    new Promise((resolve) => {
6      resolve({
7        endPoint: 'play.min.io',
8        port: 9000,
9        useSSL: true,
10        accessKey: 'Q3AM3UQ867SPQQA43P2F',
11        secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
12      });
13    }),
14});

Here is also an example, that uses the @nestjs/config.

1import { MinioModule, MinioConfig } from 'minio-nestjs-client';
2
3MinioModule.forRootAsync({
4  useFactory: (config) => {
5    return config.get<MinioConfig>('config-key');
6  },
7  inject: [ConfigService],
8  import: [ConfigModule],
9});

And to access the client just use the Injection token

1import { MINIO_CLIENT, MinioClient } from 'minio-nestjs-client';
2
3@Injectable()
4export class MyService {
5  public constructor(private readonly client: MinioClient) {}
6
7  public async doSomethingWithABucket(): Promise<string> {
8    const bucketExists = await this.client.bucketExists('test');
9
10    return bucketExists ? 'We have a bucket' : 'We dont have a bucket';
11  }
12}

Development

1. Clone the repo
2. Run yarn install

1cd minio-nestjs-client
2yarn install

Running tests

1yarn test