storage.Class.StorageModule

@sclable/nestjs-libs / storage / StorageModule

Class: StorageModule

The main module In the root module import StorageModule.forRootAsync(). The module only accepts async configuration options so provide a factory for getting the configuration.

Example: app.module.ts

import { Module } from '@nestjs/common'
import { ConfigService } from '@nestjs/config'
import { StorageModule, StorageModuleOptions, StorageType } from '@sclable/nestjs-storage'

@Module({
  imports: [
    // ...
    StorageModule.forRootAsync({
      useFactory: (config: ConfigService) => ({
        ...config.get<StorageModuleOptions>('storage', {
          defaultDriver: StorageType.DUMMY,
          config: {},
        }),
      }),
      inject: [ConfigService],
    }),
    // ...
  ],
})
export class AppModule {}

Constructors

new StorageModule()

new StorageModule(): StorageModule

Returns

StorageModule

Methods

forRoot()

static forRoot(options): DynamicModule

Parameters

• options: StorageModuleOptions

Returns

DynamicModule

Defined in

packages/storage/src/storage.module.ts:42

---

forRootAsync()

static forRootAsync(asyncOptions): DynamicModule

Parameters

• asyncOptions: AsyncProvider<StorageModuleOptions>

Returns

DynamicModule

Defined in

packages/storage/src/storage.module.ts:54