@nestjs/common 8.4.6 → 9.0.0-next.2

package/Readme.md

@@ -65,19 +65,20 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 <td>
 <a href="https://nx.dev" target="_blank"><img src="https://nestjs.com/img/nx-logo.png" height="45" valign="middle" /></a></td>
     <td>
-<a href="https://valor-software.com/" target="_blank"><img src="https://docs.nestjs.com/assets/sponsors/valor-software.png" width="170" valign="middle" /></a></td>
+<a href="https://valor-software.com/" target="_blank"><img src="https://docs.nestjs.com/assets/sponsors/valor-software.png" width="170" valign="middle" /></a></td><td>
+<a href="https://amplication.com/" target="_blank"><img src="https://nestjs.com/img/amplication-logo.svg" width="190" valign="middle" /></a></td>
 </tr></table>
 
 #### Gold Sponsors
 
 <table style="text-align:center;"><tr><td>
-  <a href="https://careers.labster.com/departments/platform" target="_blank"><img src="https://nestjs.com/img/labster-logo.png" width="170" valign="middle" /></a></td><td>
 <a href="https://weld.app/" target="_blank"><img src="https://nestjs.com/img/weld-logo.svg" width="140" valign="middle" /></a></td>
 <td>
 <a href="https://intrinsic.ventures/" target="_blank"><img src="https://nestjs.com/img/intrinisic-logo.png" width="210" valign="middle" /></a></td>
  <td>
 <a href="https://jetbrains.com/" target="_blank"><img src="https://nestjs.com/img/jetbrains-logo.svg" width="110" valign="middle" /></a></td><td>
-<a href="https://snyk.co/nestjs" target="_blank"><img src="https://nestjs.com/img/snyk-logo-black.png" width="185" valign="middle" /></a></td></</tr></table>
+<a href="https://snyk.co/nestjs" target="_blank"><img src="https://nestjs.com/img/snyk-logo-black.png" width="185" valign="middle" /></a></td><td>
+<a href="https://fuseautotech.com/" target="_blank"><img src="https://nestjs.com/img/fuse-logo.svg" width="105" valign="middle" /></a></td></</tr></table>
 
 #### Silver Sponsors
 

package/cache/cache.constants.d.ts

@@ -1,4 +1,3 @@
 export declare const CACHE_MANAGER = "CACHE_MANAGER";
-export declare const CACHE_MODULE_OPTIONS = "CACHE_MODULE_OPTIONS";
 export declare const CACHE_KEY_METADATA = "cache_module:cache_key";
 export declare const CACHE_TTL_METADATA = "cache_module:cache_ttl";

package/cache/cache.constants.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CACHE_TTL_METADATA = exports.CACHE_KEY_METADATA = exports.CACHE_MODULE_OPTIONS = exports.CACHE_MANAGER = void 0;
+exports.CACHE_TTL_METADATA = exports.CACHE_KEY_METADATA = exports.CACHE_MANAGER = void 0;
 exports.CACHE_MANAGER = 'CACHE_MANAGER';
-exports.CACHE_MODULE_OPTIONS = 'CACHE_MODULE_OPTIONS';
 exports.CACHE_KEY_METADATA = 'cache_module:cache_key';
 exports.CACHE_TTL_METADATA = 'cache_module:cache_ttl';

package/cache/cache.module-definition.d.ts

@@ -0,0 +1,2 @@
+import { CacheModuleOptions } from './interfaces/cache-module.interface';
+export declare const ConfigurableModuleClass: import("../module-utils").ConfigurableModuleCls<CacheModuleOptions<Record<string, any>>, "register", "createCacheOptions", {}>, MODULE_OPTIONS_TOKEN: string | symbol;

package/cache/cache.module-definition.js

@@ -0,0 +1,10 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MODULE_OPTIONS_TOKEN = exports.ConfigurableModuleClass = void 0;
+const module_utils_1 = require("../module-utils");
+_a = new module_utils_1.ConfigurableModuleBuilder({
+    moduleName: 'Cache',
+})
+    .setFactoryMethodName('createCacheOptions')
+    .build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN;

package/cache/cache.module.d.ts

@@ -1,4 +1,5 @@
 import { DynamicModule } from '../interfaces';
+import { ConfigurableModuleClass } from './cache.module-definition';
 import { CacheModuleAsyncOptions, CacheModuleOptions } from './interfaces/cache-module.interface';
 /**
  * Module that provides Nest cache-manager.
@@ -7,7 +8,7 @@ import { CacheModuleAsyncOptions, CacheModuleOptions } from './interfaces/cache-
  *
  * @publicApi
  */
-export declare class CacheModule {
+export declare class CacheModule extends ConfigurableModuleClass {
     /**
      * Configure the cache manager statically.
      *
@@ -25,6 +26,4 @@ export declare class CacheModule {
      * @see [Async configuration](https://docs.nestjs.com/techniques/caching#async-configuration)
      */
     static registerAsync<StoreConfig extends Record<any, any> = Record<string, any>>(options: CacheModuleAsyncOptions<StoreConfig>): DynamicModule;
-    private static createAsyncProviders;
-    private static createAsyncOptionsProvider;
 }

package/cache/cache.module.js

@@ -1,10 +1,10 @@
 "use strict";
-var CacheModule_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CacheModule = void 0;
 const tslib_1 = require("tslib");
 const decorators_1 = require("../decorators");
 const cache_constants_1 = require("./cache.constants");
+const cache_module_definition_1 = require("./cache.module-definition");
 const cache_providers_1 = require("./cache.providers");
 /**
  * Module that provides Nest cache-manager.
@@ -13,7 +13,7 @@ const cache_providers_1 = require("./cache.providers");
  *
  * @publicApi
  */
-let CacheModule = CacheModule_1 = class CacheModule {
+let CacheModule = class CacheModule extends cache_module_definition_1.ConfigurableModuleClass {
     /**
      * Configure the cache manager statically.
      *
@@ -22,11 +22,7 @@ let CacheModule = CacheModule_1 = class CacheModule {
      * @see [Customize caching](https://docs.nestjs.com/techniques/caching#customize-caching)
      */
     static register(options = {}) {
-        return {
-            module: CacheModule_1,
-            global: options.isGlobal,
-            providers: [{ provide: cache_constants_1.CACHE_MODULE_OPTIONS, useValue: options }],
-        };
+        return Object.assign({ global: options.isGlobal }, super.register(options));
     }
     /**
      * Configure the cache manager dynamically.
@@ -37,44 +33,11 @@ let CacheModule = CacheModule_1 = class CacheModule {
      * @see [Async configuration](https://docs.nestjs.com/techniques/caching#async-configuration)
      */
     static registerAsync(options) {
-        return {
-            module: CacheModule_1,
-            global: options.isGlobal,
-            imports: options.imports,
-            providers: [
-                ...this.createAsyncProviders(options),
-                ...(options.extraProviders || []),
-            ],
-        };
-    }
-    static createAsyncProviders(options) {
-        if (options.useExisting || options.useFactory) {
-            return [this.createAsyncOptionsProvider(options)];
-        }
-        return [
-            this.createAsyncOptionsProvider(options),
-            {
-                provide: options.useClass,
-                useClass: options.useClass,
-            },
-        ];
-    }
-    static createAsyncOptionsProvider(options) {
-        if (options.useFactory) {
-            return {
-                provide: cache_constants_1.CACHE_MODULE_OPTIONS,
-                useFactory: options.useFactory,
-                inject: options.inject || [],
-            };
-        }
-        return {
-            provide: cache_constants_1.CACHE_MODULE_OPTIONS,
-            useFactory: async (optionsFactory) => optionsFactory.createCacheOptions(),
-            inject: [options.useExisting || options.useClass],
-        };
+        const moduleDefinition = super.registerAsync(options);
+        return Object.assign(Object.assign({ global: options.isGlobal }, moduleDefinition), { providers: moduleDefinition.providers.concat(options.extraProviders) });
     }
 };
-CacheModule = CacheModule_1 = tslib_1.__decorate([
+CacheModule = tslib_1.__decorate([
     (0, decorators_1.Module)({
         providers: [(0, cache_providers_1.createCacheManager)()],
         exports: [cache_constants_1.CACHE_MANAGER],

package/cache/cache.providers.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCacheManager = void 0;
 const load_package_util_1 = require("../utils/load-package.util");
 const cache_constants_1 = require("./cache.constants");
+const cache_module_definition_1 = require("./cache.module-definition");
 const default_options_1 = require("./default-options");
 /**
  * Creates a CacheManager Provider.
@@ -18,7 +19,7 @@ function createCacheManager() {
                 ? cacheManager.multiCaching(options.map(store => cacheManager.caching(Object.assign(Object.assign({}, default_options_1.defaultCacheOptions), (store || {})))))
                 : cacheManager.caching(Object.assign(Object.assign({}, default_options_1.defaultCacheOptions), (options || {})));
         },
-        inject: [cache_constants_1.CACHE_MODULE_OPTIONS],
+        inject: [cache_module_definition_1.MODULE_OPTIONS_TOKEN],
     };
 }
 exports.createCacheManager = createCacheManager;

package/cache/interfaces/cache-module.interface.d.ts

@@ -1,4 +1,5 @@
-import { ModuleMetadata, Provider, Type } from '../../interfaces';
+import { Provider, Type } from '../../interfaces';
+import { ConfigurableModuleAsyncOptions } from '../../module-utils';
 import { CacheManagerOptions } from './cache-manager.interface';
 export declare type CacheModuleOptions<StoreConfig extends Record<any, any> = Record<string, any>> = CacheManagerOptions & StoreConfig & {
     /**
@@ -24,7 +25,7 @@ export interface CacheOptionsFactory<StoreConfig extends Record<any, any> = Reco
  *
  * @publicApi
  */
-export interface CacheModuleAsyncOptions<StoreConfig extends Record<any, any> = Record<string, any>> extends Pick<ModuleMetadata, 'imports'> {
+export interface CacheModuleAsyncOptions<StoreConfig extends Record<any, any> = Record<string, any>> extends ConfigurableModuleAsyncOptions<CacheModuleOptions<StoreConfig>, keyof CacheOptionsFactory> {
     /**
      * Injection token resolving to an existing provider. The provider must implement
      * the `CacheOptionsFactory` interface.
@@ -44,6 +45,9 @@ export interface CacheModuleAsyncOptions<StoreConfig extends Record<any, any> =
      * Dependencies that a Factory may inject.
      */
     inject?: any[];
+    /**
+     * Extra providers to be registered within a scope of this module.
+     */
     extraProviders?: Provider[];
     /**
      * If "true', register `CacheModule` as a global module.

package/decorators/core/controller.decorator.js

@@ -46,7 +46,7 @@ function Controller(prefixOrOptions) {
             : [
                 prefixOrOptions.path || defaultPath,
                 prefixOrOptions.host,
-                { scope: prefixOrOptions.scope },
+                { scope: prefixOrOptions.scope, durable: prefixOrOptions.durable },
                 Array.isArray(prefixOrOptions.version)
                     ? Array.from(new Set(prefixOrOptions.version))
                     : prefixOrOptions.version,

package/exceptions/http.exception.d.ts

@@ -35,6 +35,15 @@ export declare class HttpException extends Error {
      * @param status HTTP response status code.
      */
     constructor(response: string | Record<string, any>, status: number);
+    cause: Error | undefined;
+    /**
+     * Configures error chaining support
+     *
+     * See:
+     * - https://nodejs.org/en/blog/release/v16.9.0/#error-cause
+     * - https://github.com/microsoft/TypeScript/issues/45167
+     */
+    initCause(): void;
     initMessage(): void;
     initName(): void;
     getResponse(): string | object;

package/exceptions/http.exception.js

@@ -42,6 +42,19 @@ class HttpException extends Error {
         this.status = status;
         this.initMessage();
         this.initName();
+        this.initCause();
+    }
+    /**
+     * Configures error chaining support
+     *
+     * See:
+     * - https://nodejs.org/en/blog/release/v16.9.0/#error-cause
+     * - https://github.com/microsoft/TypeScript/issues/45167
+     */
+    initCause() {
+        if (this.response instanceof Error) {
+            this.cause = this.response;
+        }
     }
     initMessage() {
         if ((0, shared_utils_1.isString)(this.response)) {

package/index.d.ts

@@ -4,8 +4,8 @@ export * from './decorators';
 export * from './enums';
 export * from './exceptions';
 export * from './file-stream';
-export * from './http';
-export { Abstract, ArgumentMetadata, ArgumentsHost, BeforeApplicationShutdown, CallHandler, CanActivate, ClassProvider, ContextType, DynamicModule, ExceptionFilter, ExecutionContext, ExistingProvider, FactoryProvider, ForwardReference, HttpServer, INestApplication, INestApplicationContext, INestMicroservice, InjectionToken, IntrospectionResult, MessageEvent, MiddlewareConsumer, ModuleMetadata, NestApplicationOptions, NestHybridApplicationOptions, NestInterceptor, NestMiddleware, NestModule, OnApplicationBootstrap, OnApplicationShutdown, OnModuleDestroy, OnModuleInit, OptionalFactoryDependency, Paramtype, PipeTransform, Provider, RpcExceptionFilter, Scope, ScopeOptions, Type, ValidationError, ValueProvider, VersioningOptions, VERSION_NEUTRAL, WebSocketAdapter, WsExceptionFilter, WsMessageHandler, } from './interfaces';
+export { Abstract, ArgumentMetadata, ArgumentsHost, BeforeApplicationShutdown, CallHandler, CanActivate, ClassProvider, ContextType, DynamicModule, ExceptionFilter, ExecutionContext, ExistingProvider, FactoryProvider, ForwardReference, HttpServer, INestApplication, INestApplicationContext, INestMicroservice, InjectionToken, IntrospectionResult, MessageEvent, MiddlewareConsumer, ModuleMetadata, NestApplicationOptions, NestHybridApplicationOptions, NestInterceptor, NestMiddleware, NestModule, OnApplicationBootstrap, OnApplicationShutdown, OnModuleDestroy, OnModuleInit, OptionalFactoryDependency, Paramtype, PipeTransform, Provider, RawBodyRequest, RpcExceptionFilter, Scope, ScopeOptions, Type, ValidationError, ValueProvider, VersioningOptions, VERSION_NEUTRAL, WebSocketAdapter, WsExceptionFilter, WsMessageHandler, } from './interfaces';
+export * from './module-utils';
 export * from './pipes';
 export * from './serializer';
 export * from './services';

package/index.js

@@ -14,10 +14,10 @@ tslib_1.__exportStar(require("./decorators"), exports);
 tslib_1.__exportStar(require("./enums"), exports);
 tslib_1.__exportStar(require("./exceptions"), exports);
 tslib_1.__exportStar(require("./file-stream"), exports);
-tslib_1.__exportStar(require("./http"), exports);
 var interfaces_1 = require("./interfaces");
 Object.defineProperty(exports, "Scope", { enumerable: true, get: function () { return interfaces_1.Scope; } });
 Object.defineProperty(exports, "VERSION_NEUTRAL", { enumerable: true, get: function () { return interfaces_1.VERSION_NEUTRAL; } });
+tslib_1.__exportStar(require("./module-utils"), exports);
 tslib_1.__exportStar(require("./pipes"), exports);
 tslib_1.__exportStar(require("./serializer"), exports);
 tslib_1.__exportStar(require("./services"), exports);

package/interfaces/http/http-server.interface.d.ts

@@ -27,8 +27,10 @@ export interface HttpServer<TRequest = any, TResponse = any> {
     listen(port: number | string, hostname: string, callback?: () => void): any;
     reply(response: any, body: any, statusCode?: number): any;
     status(response: any, statusCode: number): any;
+    end(response: any, message?: string): any;
     render(response: any, view: string, options: any): any;
     redirect(response: any, statusCode: number, url: string): any;
+    isHeadersSent(response: any): boolean;
     setHeader(response: any, name: string, value: string): any;
     setErrorHandler?(handler: Function, prefix?: string): any;
     setNotFoundHandler?(handler: Function, prefix?: string): any;
@@ -47,5 +49,5 @@ export interface HttpServer<TRequest = any, TResponse = any> {
     close(): any;
     getType(): string;
     init?(): Promise<void>;
-    applyVersionFilter?(handler: Function, version: VersionValue, versioningOptions: VersioningOptions): <TRequest extends Record<string, any> = any, TResponse = any>(req: TRequest, res: TResponse, next: () => void) => any;
+    applyVersionFilter(handler: Function, version: VersionValue, versioningOptions: VersioningOptions): (req: TRequest, res: TResponse, next: () => void) => Function;
 }

package/interfaces/http/index.d.ts

@@ -1,2 +1,3 @@
 export * from './http-server.interface';
 export * from './message-event.interface';
+export * from './raw-body-request.interface';

package/interfaces/http/index.js

@@ -3,3 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./http-server.interface"), exports);
 tslib_1.__exportStar(require("./message-event.interface"), exports);
+tslib_1.__exportStar(require("./raw-body-request.interface"), exports);

package/interfaces/modules/provider.interface.d.ts

@@ -39,6 +39,19 @@ export interface ClassProvider<T = any> {
      * Optional enum defining lifetime of the provider that is injected.
      */
     scope?: Scope;
+    /**
+     * This option is only available on factory providers!
+     *
+     * @see [Use factory](https://docs.nestjs.com/fundamentals/custom-providers#factory-providers-usefactory)
+     */
+    inject?: never;
+    /**
+     * Flags provider as durable. This flag can be used in combination with custom context id
+     * factory strategy to construct lazy DI subtrees.
+     *
+     * This flag can be used only in conjunction with scope = Scope.REQUEST.
+     */
+    durable?: boolean;
 }
 /**
  * Interface defining a *Value* type provider.
@@ -64,6 +77,12 @@ export interface ValueProvider<T = any> {
      * Instance of a provider to be injected.
      */
     useValue: T;
+    /**
+     * This option is only available on factory providers!
+     *
+     * @see [Use factory](https://docs.nestjs.com/fundamentals/custom-providers#factory-providers-usefactory)
+     */
+    inject?: never;
 }
 /**
  * Interface defining a *Factory* type provider.
@@ -93,7 +112,7 @@ export interface FactoryProvider<T = any> {
     /**
      * Factory function that returns an instance of the provider to be injected.
      */
-    useFactory: (...args: any[]) => T;
+    useFactory: (...args: any[]) => T | Promise<T>;
     /**
      * Optional list of providers to be injected into the context of the Factory function.
      */
@@ -102,6 +121,13 @@ export interface FactoryProvider<T = any> {
      * Optional enum defining lifetime of the provider that is returned by the Factory function.
      */
     scope?: Scope;
+    /**
+     * Flags provider as durable. This flag can be used in combination with custom context id
+     * factory strategy to construct lazy DI subtrees.
+     *
+     * This flag can be used only in conjunction with scope = Scope.REQUEST.
+     */
+    durable?: boolean;
 }
 /**
  * Interface defining an *Existing* (aliased) type provider.

package/interfaces/nest-application.interface.d.ts

@@ -44,15 +44,6 @@ export interface INestApplication extends INestApplicationContext {
      */
     listen(port: number | string, callback?: () => void): Promise<any>;
     listen(port: number | string, hostname: string, callback?: () => void): Promise<any>;
-    /**
-     * Starts the application (can be awaited).
-     * @deprecated use "listen" instead.
-     *
-     * @param {number|string} port
-     * @param {string} [hostname]
-     * @returns {Promise}
-     */
-    listenAsync(port: number | string, hostname?: string): Promise<any>;
     /**
      * Returns the url the application is listening at, based on OS and IP version. Returns as an IP value either in IPv6 or IPv4
      *
@@ -109,13 +100,6 @@ export interface INestApplication extends INestApplicationContext {
      * @returns {Promise}
      */
     startAllMicroservices(): Promise<this>;
-    /**
-     * Starts all connected microservices and can be awaited.
-     * @deprecated use "startAllMicroservices" instead.
-     *
-     * @returns {Promise}
-     */
-    startAllMicroservicesAsync(): Promise<this>;
     /**
      * Registers exception filters as global filters (will be used within
      * every HTTP route handler)

package/interfaces/nest-microservice.interface.d.ts

@@ -16,13 +16,6 @@ export interface INestMicroservice extends INestApplicationContext {
      * @returns {void}
      */
     listen(): Promise<any>;
-    /**
-     * Starts the microservice (can be awaited).
-     * @deprecated use "listen" instead.
-     *
-     * @returns {Promise}
-     */
-    listenAsync(): Promise<any>;
     /**
      * Register Ws Adapter which will be used inside Gateways.
      * Use when you want to override default `socket.io` library.

package/interfaces/scope-options.interface.d.ts

@@ -27,4 +27,11 @@ export interface ScopeOptions {
      * Specifies the lifetime of an injected Provider or Controller.
      */
     scope?: Scope;
+    /**
+     * Flags provider as durable. This flag can be used in combination with custom context id
+     * factory strategy to construct lazy DI subtrees.
+     *
+     * This flag can be used only in conjunction with scope = Scope.REQUEST.
+     */
+    durable?: boolean;
 }

package/module-utils/configurable-module.builder.d.ts

@@ -0,0 +1,93 @@
+import { DynamicModule } from '../interfaces';
+import { Logger } from '../services/logger.service';
+import { DEFAULT_FACTORY_CLASS_METHOD_KEY, DEFAULT_METHOD_KEY } from './constants';
+import { ConfigurableModuleHost } from './interfaces/configurable-module-host.interface';
+/**
+ * @publicApi
+ */
+export interface ConfigurableModuleBuilderOptions {
+    /**
+     * Specified what injection token should be used for the module options provider.
+     * By default, an auto-generated UUID will be used.
+     */
+    optionsInjectionToken?: string | symbol;
+    /**
+     * By default, an UUID will be used as a module options provider token.
+     * Explicitly specifying the "moduleName" will instruct the "ConfigurableModuleBuilder"
+     * to use a more descriptive provider token.
+     *
+     * For example, if `moduleName: "Cache"` then auto-generated provider token will be "CACHE_MODULE_OPTIONS".
+     */
+    moduleName?: string;
+    /**
+     * Indicates whether module should always be "transient", meaning,
+     * every time you call the static method to construct a dynamic module,
+     * regardless of what arguments you pass in, a new "unique" module will be created.
+     *
+     * @default false
+     */
+    alwaysTransient?: boolean;
+}
+/**
+ * Factory that lets you create configurable modules and
+ * provides a way to reduce the majority of dynamic module boilerplate.
+ *
+ * @publicApi
+ */
+export declare class ConfigurableModuleBuilder<ModuleOptions, StaticMethodKey extends string = typeof DEFAULT_METHOD_KEY, FactoryClassMethodKey extends string = typeof DEFAULT_FACTORY_CLASS_METHOD_KEY, ExtraModuleDefinitionOptions = {}> {
+    protected readonly options: ConfigurableModuleBuilderOptions;
+    protected staticMethodKey: StaticMethodKey;
+    protected factoryClassMethodKey: FactoryClassMethodKey;
+    protected extras: ExtraModuleDefinitionOptions;
+    protected transformModuleDefinition: (definition: DynamicModule, extraOptions: ExtraModuleDefinitionOptions) => DynamicModule;
+    protected readonly logger: Logger;
+    constructor(options?: ConfigurableModuleBuilderOptions, parentBuilder?: ConfigurableModuleBuilder<ModuleOptions>);
+    /**
+     * Registers the "extras" object (a set of extra options that can be used to modify the dynamic module definition).
+     * Values you specify within the "extras" object will be used as default values (that can be overriden by module consumers).
+     *
+     * This method also applies the so-called "module definition transform function" that takes the auto-generated
+     * dynamic module object ("DynamicModule") and the actual consumer "extras" object as input parameters.
+     * The "extras" object consists of values explicitly specified by module consumers and default values.
+     *
+     * @example
+     * ```typescript
+     * .setExtras<{ isGlobal?: boolean }>({ isGlobal: false }, (definition, extras) =>
+     *    ({ ...definition, global: extras.isGlobal })
+     * )
+     * ```
+     */
+    setExtras<ExtraModuleDefinitionOptions>(extras: ExtraModuleDefinitionOptions, transformDefinition: (definition: DynamicModule, extras: ExtraModuleDefinitionOptions) => DynamicModule): ConfigurableModuleBuilder<ModuleOptions, StaticMethodKey, FactoryClassMethodKey, ExtraModuleDefinitionOptions>;
+    /**
+     * Dynamic modules must expose public static methods that let you pass in
+     * configuration parameters (control the module's behavior from the outside).
+     * Some frequently used names that you may have seen in other modules are:
+     * "forRoot", "forFeature", "register", "configure".
+     *
+     * This method "setClassMethodName" lets you specify the name of the
+     * method that will be auto-generated.
+     *
+     * @param key name of the method
+     */
+    setClassMethodName<StaticMethodKey extends string>(key: StaticMethodKey): ConfigurableModuleBuilder<ModuleOptions, StaticMethodKey, FactoryClassMethodKey, ExtraModuleDefinitionOptions>;
+    /**
+     * Asynchronously configured modules (that rely on other modules, i.e. "ConfigModule")
+     * let you pass the configuration factory class that will be registered and instantiated as a provider.
+     * This provider then will be used to retrieve the module's configuration. To provide the configuration,
+     * the corresponding factory method must be implemented.
+     *
+     * This method ("setFactoryMethodName") lets you control what method name will have to be
+     * implemented by the config factory (default is "create").
+     *
+     * @param key name of the method
+     */
+    setFactoryMethodName<FactoryClassMethodKey extends string>(key: FactoryClassMethodKey): ConfigurableModuleBuilder<ModuleOptions, StaticMethodKey, FactoryClassMethodKey, ExtraModuleDefinitionOptions>;
+    /**
+     * Returns an object consisting of multiple properties that lets you
+     * easily construct dynamic configurable modules. See "ConfigurableModuleHost" interface for more details.
+     */
+    build(): ConfigurableModuleHost<ModuleOptions, StaticMethodKey, FactoryClassMethodKey, ExtraModuleDefinitionOptions>;
+    private constructInjectionTokenString;
+    private createConfigurableModuleCls;
+    private createTypeProxy;
+}