File

lib/common/user/user.module.ts

Description

Module is responsible for managing system users

Methods

Static forRoot
forRoot(options: UserModuleOptions)
Parameters :
Name Type Optional Default value
options UserModuleOptions No { service: BasicUserService, }
Returns : DynamicModule
/*
 * Copyright 2023 Alexander Kiriliuk
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

import { DynamicModule, Module } from "@nestjs/common";
import { BasicUserService } from "./user-service-basic.service";
import { TypeOrmModule } from "@nestjs/typeorm";
import { UserEntity } from "./entity/user.entity";
import { UserModuleOptions, UserService } from "./user.types";
import { LogModule } from "../../shared/modules/log/log.module";
import { CacheModule } from "../../shared/modules/cache/cache.module";

/**
 * Module is responsible for managing system users
 */
@Module({})
export class UserModule {
  static forRoot(
    options: UserModuleOptions = {
      service: BasicUserService,
    },
  ): DynamicModule {
    return {
      module: UserModule,
      imports: [LogModule, CacheModule, TypeOrmModule.forFeature([UserEntity])],
      providers: [
        {
          provide: UserService,
          useClass: options.service,
        },
      ],
      exports: [UserService],
    };
  }
}

results matching ""

    No results matching ""