HomeOfThings - common utilities for NestJs

HomeOfThings

installation

1npm install @homeofthings/nestjs-utils

Dynamic Modules

quick start

1export const MY_MODULE_OPTIONS_TOKEN = 'MY_MODULE_OPTIONS_TOKEN';
2export interface MyModuleOptions {
3  ....
4}
5
6@Module({
7  providers: [MyService],
8  exports: [MyService],
9})
10export class MyModule extends createDynamicRootModule<MyModule, MyModuleOptions>(MY_MODULE_OPTIONS_TOKEN) {
11}

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:

1const myModuleOptions: MyModuleOptions = {
2  ...
3}
4
5@Module({
6  imports: [MyModule.forRoot(MyModule, myModuleOptions)],
7})
8export class AppModule {}

• use it asynchonously:

1const myAsyncModuleOptions: AsyncModuleOptions<MyModuleOptions> = {
2  ...
3}
4
5@Module({
6  imports: [MyModule.forRootAsync(MyModule, myAsyncModuleOptions)],
7})
8export 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:

1@Module({
2  imports: [MyModule.forChild()],
3})
4export 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> - asynchronouse contest based on AsyncLocalStorage