Installation

Install the package

NPM

npm i nestjs-nvs-storage

Yarn

yarn add nestjs-nvs-storage

Configure your app module

You can register the module synchronously (register) or asynchronously (registerAsync).

Field	Type	Required	Default	Notes
provider	StorageProvider	✅ Yes	—	Select the provider implementation to use.
isGlobal	boolean	❌ No	false	When true, registers the module as global in NestJS.

NvsStorageModule.register

app.module.ts

import { Module } from '@nestjs/common';
import { NvsStorageModule, StorageProvider } from 'nestjs-nvs-storage';

@Module({
  imports: [
    NvsStorageModule.register({
      isGlobal: true,
      provider: StorageProvider.S3,
      // provider-specific config fields are documented under Providers
    }),
  ],
})
export class AppModule {}

NvsStorageModule.registerAsync

app.module.ts

import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { NvsStorageModule, StorageProvider } from 'nestjs-nvs-storage';

@Module({
  imports: [
    ConfigModule.forRoot(),

    NvsStorageModule.registerAsync({
      isGlobal: true,
      provider: StorageProvider.S3,
      imports: [ConfigModule],
      inject: [ConfigService],
      useFactory: (config: ConfigService) => ({
        // provider-specific config fields are documented under Providers
      }),
    }),
  ],
})
export class AppModule {}