inversify/InversifyJS

View on GitHub
src/constants/error_msgs.ts

Summary

Maintainability
A
0 mins
Test Coverage
export const DUPLICATED_INJECTABLE_DECORATOR = 'Cannot apply @injectable decorator multiple times.';
export const DUPLICATED_METADATA = 'Metadata key was used more than once in a parameter:';
export const NULL_ARGUMENT = 'NULL argument';
export const KEY_NOT_FOUND = 'Key Not Found';
export const AMBIGUOUS_MATCH = 'Ambiguous match found for serviceIdentifier:';
export const CANNOT_UNBIND = 'Could not unbind serviceIdentifier:';
export const NOT_REGISTERED = 'No matching bindings found for serviceIdentifier:';
export const MISSING_INJECTABLE_ANNOTATION = 'Missing required @injectable annotation in:';
export const MISSING_INJECT_ANNOTATION = 'Missing required @inject or @multiInject annotation in:';
export const UNDEFINED_INJECT_ANNOTATION = (name: string) =>
  `@inject called with undefined this could mean that the class ${name} has ` +
  'a circular dependency problem. You can use a LazyServiceIdentifer to ' +
  'overcome this limitation.';
export const CIRCULAR_DEPENDENCY = 'Circular dependency found:';
export const NOT_IMPLEMENTED = 'Sorry, this feature is not fully implemented yet.';
export const INVALID_BINDING_TYPE = 'Invalid binding type:';
export const NO_MORE_SNAPSHOTS_AVAILABLE = 'No snapshot available to restore.';
export const INVALID_MIDDLEWARE_RETURN = 'Invalid return type in middleware. Middleware must return!';
export const INVALID_FUNCTION_BINDING = 'Value provided to function binding must be a function!';
export const LAZY_IN_SYNC = (key: unknown) => `You are attempting to construct ${keyToString(key)} in a synchronous way ` +
  'but it has asynchronous dependencies.';

export const INVALID_TO_SELF_VALUE = 'The toSelf function can only be applied when a constructor is ' +
  'used as service identifier';

export const INVALID_DECORATOR_OPERATION = 'The @inject @multiInject @tagged and @named decorators ' +
  'must be applied to the parameters of a class constructor or a class property.';

export const ARGUMENTS_LENGTH_MISMATCH = (...values: unknown[]) => 'The number of constructor arguments in the derived class ' +
  `${values[0]} must be >= than the number of constructor arguments of its base class.`;

export const CONTAINER_OPTIONS_MUST_BE_AN_OBJECT = 'Invalid Container constructor argument. Container options ' +
  'must be an object.';

export const CONTAINER_OPTIONS_INVALID_DEFAULT_SCOPE = 'Invalid Container option. Default scope must ' +
  'be a string ("singleton" or "transient").';

export const CONTAINER_OPTIONS_INVALID_AUTO_BIND_INJECTABLE = 'Invalid Container option. Auto bind injectable must ' +
  'be a boolean';

export const CONTAINER_OPTIONS_INVALID_SKIP_BASE_CHECK = 'Invalid Container option. Skip base check must ' +
  'be a boolean';

export const MULTIPLE_PRE_DESTROY_METHODS = 'Cannot apply @preDestroy decorator multiple times in the same class';
export const MULTIPLE_POST_CONSTRUCT_METHODS = 'Cannot apply @postConstruct decorator multiple times in the same class';
export const ASYNC_UNBIND_REQUIRED = 'Attempting to unbind dependency with asynchronous destruction (@preDestroy or onDeactivation)';
export const POST_CONSTRUCT_ERROR = (clazz: string, errorMessage: string) => `@postConstruct error in class ${clazz}: ${errorMessage}`;
export const PRE_DESTROY_ERROR = (clazz: string, errorMessage: string) => `@preDestroy error in class ${clazz}: ${errorMessage}`;
export const ON_DEACTIVATION_ERROR = (clazz: string, errorMessage: string) => `onDeactivation() error in class ${clazz}: ${errorMessage}`;

export const CIRCULAR_DEPENDENCY_IN_FACTORY = (factoryType: string, serviceIdentifier: string) =>
  `It looks like there is a circular dependency in one of the '${factoryType}' bindings. Please investigate bindings with ` +
  `service identifier '${serviceIdentifier}'.`;

export const STACK_OVERFLOW = 'Maximum call stack size exceeded';

function keyToString(key: unknown): string {
  if (typeof key === 'function') {
    return `[function/class ${key.name || '<anonymous>'}]`;
  }
  if (typeof key === 'symbol') {
    return key.toString();
  }
  return `'${key}'`;
}