mirror of
https://github.com/nestjs/nest.git
synced 2026-02-21 23:11:44 +00:00
121 lines
4.4 KiB
TypeScript
121 lines
4.4 KiB
TypeScript
import { Type } from '@nestjs/common';
|
|
import { isNil, isSymbol } from '@nestjs/common/utils/shared.utils';
|
|
import {
|
|
InjectorDependency,
|
|
InjectorDependencyContext,
|
|
} from '../injector/injector';
|
|
import { Module } from '../injector/module';
|
|
|
|
/**
|
|
* Returns the name of an instance
|
|
* @param instance The instance which should get the name from
|
|
*/
|
|
const getInstanceName = (instance: unknown): string =>
|
|
instance && (instance as Type<any>).name;
|
|
|
|
/**
|
|
* Returns the name of the dependency
|
|
* Tries to get the class name, otherwise the string value
|
|
* (= injection token). As fallback it returns '+'
|
|
* @param dependency The dependency whichs name should get displayed
|
|
*/
|
|
const getDependencyName = (dependency: InjectorDependency): string =>
|
|
// use class name
|
|
getInstanceName(dependency) ||
|
|
// use injection token (symbol)
|
|
(isSymbol(dependency) && dependency.toString()) ||
|
|
// use string directly
|
|
(dependency as string) ||
|
|
// otherwise
|
|
'+';
|
|
|
|
/**
|
|
* Returns the name of the module
|
|
* Tries to get the class name. As fallback it returns 'current'.
|
|
* @param module The module which should get displayed
|
|
*/
|
|
const getModuleName = (module: Module) =>
|
|
(module && getInstanceName(module.metatype)) || 'current';
|
|
|
|
export const UNKNOWN_DEPENDENCIES_MESSAGE = (
|
|
type: string | symbol,
|
|
unknownDependencyContext: InjectorDependencyContext,
|
|
module: Module,
|
|
) => {
|
|
const {
|
|
index,
|
|
name = 'dependency',
|
|
dependencies,
|
|
key,
|
|
} = unknownDependencyContext;
|
|
const moduleName = getModuleName(module) || 'Module';
|
|
const dependencyName = getDependencyName(name);
|
|
|
|
let message = `Nest can't resolve dependencies of the ${type.toString()}`;
|
|
|
|
const potentialSolutions = `\n
|
|
Potential solutions:
|
|
- If ${dependencyName} is a provider, is it part of the current ${moduleName}?
|
|
- If ${dependencyName} is exported from a separate @Module, is that module imported within ${moduleName}?
|
|
@Module({
|
|
imports: [ /* the Module containing ${dependencyName} */ ]
|
|
})
|
|
`;
|
|
|
|
if (isNil(index)) {
|
|
message += `. Please make sure that the "${key.toString()}" property is available in the current context.${potentialSolutions}`;
|
|
return message;
|
|
}
|
|
const dependenciesName = (dependencies || []).map(getDependencyName);
|
|
dependenciesName[index] = '?';
|
|
|
|
message += ` (`;
|
|
message += dependenciesName.join(', ');
|
|
message += `). Please make sure that the argument ${dependencyName} at index [${index}] is available in the ${getModuleName(
|
|
module,
|
|
)} context.`;
|
|
message += potentialSolutions;
|
|
|
|
return message;
|
|
};
|
|
|
|
export const INVALID_MIDDLEWARE_MESSAGE = (
|
|
text: TemplateStringsArray,
|
|
name: string,
|
|
) => `The middleware doesn't provide the 'use' method (${name})`;
|
|
|
|
export const INVALID_MODULE_MESSAGE = (
|
|
text: TemplateStringsArray,
|
|
scope: string,
|
|
) =>
|
|
`Nest cannot create the module instance. Often, this is because of a circular dependency between modules. Use forwardRef() to avoid it.
|
|
|
|
(Read more: https://docs.nestjs.com/fundamentals/circular-dependency)
|
|
Scope [${scope}]
|
|
`;
|
|
|
|
export const UNKNOWN_EXPORT_MESSAGE = (token = 'item', module: string) => {
|
|
return `Nest cannot export a provider/module that is not a part of the currently processed module (${module}). Please verify whether the exported ${token} is available in this particular context.
|
|
|
|
Possible Solutions:
|
|
- Is ${token} part of the relevant providers/imports within ${module}?
|
|
`;
|
|
};
|
|
|
|
export const INVALID_CLASS_MESSAGE = (text: TemplateStringsArray, value: any) =>
|
|
`ModuleRef cannot instantiate class (${value} is not constructable).`;
|
|
|
|
export const INVALID_CLASS_SCOPE_MESSAGE = (
|
|
text: TemplateStringsArray,
|
|
name: string | undefined,
|
|
) =>
|
|
`${
|
|
name || 'This class'
|
|
} is marked as a scoped provider. Request and transient-scoped providers can't be used in combination with "get()" method. Please, use "resolve()" instead.`;
|
|
|
|
export const INVALID_MIDDLEWARE_CONFIGURATION = `An invalid middleware configuration has been passed inside the module 'configure()' method.`;
|
|
export const UNKNOWN_REQUEST_MAPPING = `An invalid controller has been detected. Perhaps, one of your controllers is missing @Controller() decorator.`;
|
|
export const UNHANDLED_RUNTIME_EXCEPTION = `Unhandled Runtime Exception.`;
|
|
export const INVALID_EXCEPTION_FILTER = `Invalid exception filters (@UseFilters()).`;
|
|
export const MICROSERVICES_PACKAGE_NOT_FOUND_EXCEPTION = `Unable to load @nestjs/microservices package. (Please make sure that it's already installed.)`;
|