feat(modules): udpate create function name to match fit nest terminology

golevelup · Nov 9, 2019 · d3eae4a · d3eae4a
1 parent f6eba82
commit d3eae4a
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/packages/modules/README.md b/packages/modules/README.md
@@ -43,7 +43,7 @@ and wait for the installation to finish.
 Creating a new dynamic module is now easier than ever, all that is needed is the module's name, the options that are to be provided for the module, and a constant string, symbol, or token that is to be used for providing the options through injection. Following the idea of a non-global `ConfigModule`, you can do something like the following:
 
 ```ts
-import { MakeConfigurableDynamicRootModule } from '@golevelup/nestjs-modules';
+import { createConfigurableDynamicRootModule } from '@golevelup/nestjs-modules';
 import { Module } from '@nestjs/common';
 import { CONFIG_MODULE_OPTIONS } from './config.constants'; // the constant string/symbol/token
 import { ConfigModuleOptions } from './config.options'; // the options to provide to the service
@@ -53,7 +53,7 @@ import { ConfigModule } from './config.service'; // the service to be provided t
   providers: [ConfigService],
   exports: [ConfigService]
 })
-export class ConfigModule extends MakeConfigurableDynamicRootModule<
+export class ConfigModule extends createConfigurableDynamicRootModule<
   ConfigModule,
   ConfigModuleOptions
 >(CONFIG_MODULE_OPTIONS) {}
@@ -95,7 +95,7 @@ export class ConfigModuleDependentModule {}
 if you don't like the idea of calling `externallyConfigured` every time, you can create a `static` property on the Dynamic Module and set it equal to the `externallyConfigured` method. Take the above `ConfigModule` example:
 
 ```ts
-import { MakeConfigurableDynamicRootModule } from '@golevelup/nestjs-modules';
+import { createConfigurableDynamicRootModule } from '@golevelup/nestjs-modules';
 import { Module } from '@nestjs/common';
 import { CONFIG_MODULE_OPTIONS } from './config.constants'; // the constant string/symbol/token
 import { ConfigModuleOptions } from './config.options'; // the options to provide to the service
@@ -105,7 +105,7 @@ import { ConfigModule } from './config.service'; // the service to be provided t
   providers: [ConfigService],
   exports: [ConfigService]
 })
-export class ConfigModule extends MakeConfigurableDynamicRootModule<
+export class ConfigModule extends createConfigurableDynamicRootModule<
   ConfigModule,
   ConfigModuleOptions
 >(CONFIG_MODULE_OPTIONS) {

diff --git a/packages/modules/src/dynamicModules.ts b/packages/modules/src/dynamicModules.ts
@@ -94,7 +94,7 @@ export interface IConfigurableDynamicRootModule<T, U> {
   ): Promise<DynamicModule>;
 }
 
-export function MakeConfigurableDynamicRootModule<T, U>(
+export function createConfigurableDynamicRootModule<T, U>(
   moduleConfigToken: InjectionToken,
   moduleProperties: Partial<
     Pick<ModuleMetadata, 'imports' | 'exports' | 'providers'>

diff --git a/packages/rabbitmq/src/rabbitmq.module.ts b/packages/rabbitmq/src/rabbitmq.module.ts
@@ -1,5 +1,5 @@
 import { DiscoveryModule, DiscoveryService } from '@golevelup/nestjs-discovery';
-import { MakeConfigurableDynamicRootModule } from '@golevelup/nestjs-modules';
+import { createConfigurableDynamicRootModule } from '@golevelup/nestjs-modules';
 import { DynamicModule, Logger, Module, OnModuleInit } from '@nestjs/common';
 import { ExternalContextCreator } from '@nestjs/core/helpers/external-context-creator';
 import { groupBy } from 'lodash';
@@ -11,7 +11,7 @@ import { RabbitHandlerConfig, RabbitMQConfig } from './rabbitmq.interfaces';
   imports: [DiscoveryModule]
 })
 export class RabbitMQModule
-  extends MakeConfigurableDynamicRootModule<RabbitMQModule, RabbitMQConfig>(
+  extends createConfigurableDynamicRootModule<RabbitMQModule, RabbitMQConfig>(
     RABBIT_CONFIG_TOKEN,
     {
       providers: [