feature(@common) rename modules to imports property

nestjs · Dec 21, 2017 · 864fac9 · 864fac9
1 parent 2a727b9
commit 864fac9
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/common/constants.ts b/src/common/constants.ts
@@ -1,5 +1,6 @@
 export const metadata = {
   MODULES: 'modules',
+  IMPORTS: 'imports',
   COMPONENTS: 'components',
   CONTROLLERS: 'controllers',
   EXPORTS: 'exports',

diff --git a/src/common/decorators/modules/module.decorator.ts b/src/common/decorators/modules/module.decorator.ts
@@ -5,6 +5,7 @@ import { metadata } from '../../constants';
 
 const metadataKeys = [
   metadata.MODULES,
+  metadata.IMPORTS,
   metadata.EXPORTS,
   metadata.COMPONENTS,
   metadata.CONTROLLERS,
@@ -22,21 +23,27 @@ const validateKeys = (keys: string[]) => {
 
 /**
  * Defines the module
- * - `modules` - the set of the 'imported' modules
+ * - `modules` - @deprecated the set of the 'imported' modules
+ * - `imports` - the set of the 'imported' modules
  * - `controllers` - the list of controllers (e.g. HTTP controllers)
  * - `components` - the list of components that belong to this module. They can be injected between themselves.
  * - `exports` - the set of components, which should be available for modules, which imports this module
  * @param obj {ModuleMetadata} Module metadata
  */
 export function Module(obj: {
   modules?: any[];
+  imports?: any[],
   controllers?: any[];
   components?: any[];
   exports?: any[];
 }): ClassDecorator {
   const propsKeys = Object.keys(obj);
   validateKeys(propsKeys);
 
+  obj.modules = obj.imports && !obj.modules
+    ? obj.imports
+    : obj.modules;
+
   return (target: object) => {
     for (const property in obj) {
       if (obj.hasOwnProperty(property)) {