@homeofthings/nestjs-utils

HomeOfThings - common utilities for NestJs

HomeOfThings

installation

npm install @homeofthings/nestjs-utils

Dynamic Modules

quick start

export const MY_MODULE_OPTIONS_TOKEN = 'MY_MODULE_OPTIONS_TOKEN';
export interface MyModuleOptions {
  ....
}

@Module({
  providers: [MyService],
  exports: [MyService],
})
export class MyModule extends createDynamicRootModule<MyModule, MyModuleOptions>(MY_MODULE_OPTIONS_TOKEN) {
}

NOTE: additional module properties for 'imports', 'exports', 'providers' or 'controllers' can be passed as second parameter to this function

NOTE: of course the module can also be global scoped by the @Global() decorator

• use it synchronously:

const myModuleOptions: MyModuleOptions = {
  ...
}

@Module({
  imports: [MyModule.forRoot(MyModule, myModuleOptions)],
})
export class AppModule {}

• use it asynchonously:

const myAsyncModuleOptions: AsyncModuleOptions<MyModuleOptions> = {
  ...
}

@Module({
  imports: [MyModule.forRootAsync(MyModule, myAsyncModuleOptions)],
})
export class AppModule {}

NOTE: forRoot/forRootAsync throws if the module is already registered. You can call register/registerAsync if you really want to register it more than once

• import it in any child module:

@Module({
  imports: [MyModule.forChild()],
})
export class ChildModule {}

NOTE: no need to do this if the module is global scoped

examples

• providing single option using either forRoot or forRootAsync

@homeofthings/nestjs-logger

• providing multiple options using eihter register or registerAsync (e.g. providing multiple connections)

@homeofthings/nestjs-sqlite3

more utilities

• class LruCache<T> - LRU cache
• class AsyncContext<T> - wrapper for AsyncLocalStorage
• function writeFileIfChanged(outputPath: string, content: string): Promise<boolean> - write a file if provided content is different to exiting content