@lppedd/di-wise-neo 0.14.1 → 0.14.2

package/dist/cjs/index.d.ts

@@ -617,13 +617,19 @@ declare function forwardRef<Value>(token: () => Token<Value>): TokenRef<Value>;
 /**
  * Parameter decorator that injects the instance associated with the given class.
  *
- * Throws an error if the class is not registered in the container.
+ * Throws an error if:
+ * - The class is not registered in the container.
+ * - A circular dependency is detected. Use function injection with {@link injectBy}
+ *   if resolving circular dependencies is necessary.
  */
 declare function Inject<Instance extends object>(Class: Constructor<Instance>): ParameterDecorator;
 /**
  * Parameter decorator that injects the value associated with the given token.
  *
- * Throws an error if the token is not registered in the container.
+ * Throws an error if:
+ * - The token is not registered in the container.
+ * - A circular dependency is detected. Use function injection with {@link injectBy}
+ *   if resolving circular dependencies is necessary.
  */
 declare function Inject<Value>(token: Token<Value>): ParameterDecorator;
 /**
@@ -632,7 +638,10 @@ declare function Inject<Value>(token: Token<Value>): ParameterDecorator;
  * Allows referencing a token declared later in the file by using the
  * {@link forwardRef} helper function.
  *
- * Throws an error if the token is not registered in the container.
+ * Throws an error if:
+ * - The token is not registered in the container.
+ * - A circular dependency is detected. Use function injection with {@link injectBy}
+ *   if resolving circular dependencies is necessary.
  *
  * @example
  * ```ts
@@ -681,14 +690,18 @@ declare function Injectable<This extends object, Value extends This>(tokens: Tok
  * Parameter decorator that injects all instances provided by the registrations
  * associated with the given class.
  *
- * Throws an error if the class is not registered in the container.
+ * Throws an error if:
+ * - The class is not registered in the container.
+ * - A circular dependency is detected.
  */
 declare function InjectAll<Instance extends object>(Class: Constructor<Instance>): ParameterDecorator;
 /**
  * Parameter decorator that injects all values provided by the registrations
  * associated with the given token.
  *
- * Throws an error if the token is not registered in the container.
+ * Throws an error if:
+ * - The token is not registered in the container.
+ * - A circular dependency is detected.
  */
 declare function InjectAll<Value>(token: Token<Value>): ParameterDecorator;
 /**
@@ -698,7 +711,9 @@ declare function InjectAll<Value>(token: Token<Value>): ParameterDecorator;
  * Allows referencing a token declared later in the file by using the
  * {@link forwardRef} helper function.
  *
- * Throws an error if the token is not registered in the container.
+ * Throws an error if:
+ * - The token is not registered in the container.
+ * - A circular dependency is detected.
  *
  * @example
  * ```ts
@@ -734,11 +749,17 @@ declare function Named(name: string): ClassDecorator & ParameterDecorator;
 /**
  * Parameter decorator that injects the instance associated with the given class,
  * or `undefined` if the class is not registered in the container.
+ *
+ * Throws an error if a circular dependency is detected. Use function injection
+ * with {@link optionalBy} if resolving circular dependencies is necessary.
  */
 declare function Optional<Instance extends object>(Class: Constructor<Instance>): ParameterDecorator;
 /**
  * Parameter decorator that injects the value associated with the given token,
  * or `undefined` if the token is not registered in the container.
+ *
+ * Throws an error if a circular dependency is detected. Use function injection
+ * with {@link optionalBy} if resolving circular dependencies is necessary.
  */
 declare function Optional<Value>(token: Token<Value>): ParameterDecorator;
 /**
@@ -748,6 +769,9 @@ declare function Optional<Value>(token: Token<Value>): ParameterDecorator;
  * Allows referencing a token declared later in the file by using the
  * {@link forwardRef} helper function.
  *
+ * Throws an error if a circular dependency is detected. Use function injection
+ * with {@link optionalBy} if resolving circular dependencies is necessary.
+ *
  * @example
  * ```ts
  * class Wizard {
@@ -763,12 +787,16 @@ declare function Optional<Value>(tokens: TokenRef<Value>): ParameterDecorator;
  * Parameter decorator that injects all instances provided by the registrations
  * associated with the given class or an empty array if the class is not registered
  * in the container.
+ *
+ * Throws an error if a circular dependency is detected.
  */
 declare function OptionalAll<Instance extends object>(Class: Constructor<Instance>): ParameterDecorator;
 /**
  * Parameter decorator that injects all values provided by the registrations
  * associated with the given token or an empty array if the token is not registered
  * in the container.
+ *
+ * Throws an error if a circular dependency is detected.
  */
 declare function OptionalAll<Value>(token: Token<Value>): ParameterDecorator;
 /**
@@ -779,6 +807,8 @@ declare function OptionalAll<Value>(token: Token<Value>): ParameterDecorator;
  * Allows referencing a token declared later in the file by using the
  * {@link forwardRef} helper function.
  *
+ * Throws an error if a circular dependency is detected.
+ *
  * @example
  * ```ts
  * class Wizard {
@@ -817,13 +847,19 @@ declare function Scoped(scope: Scope): ClassDecorator;
 /**
  * Injects the instance associated with the given class.
  *
- * Throws an error if the class is not registered in the container.
+ * Throws an error if:
+ * - The class is not registered in the container.
+ * - A circular dependency is detected. Use {@link injectBy} if resolving
+ *   circular dependencies is necessary.
  */
 declare function inject<Instance extends object>(Class: Constructor<Instance>, name?: string): Instance;
 /**
  * Injects the value associated with the given token.
  *
- * Throws an error if the token is not registered in the container.
+ * Throws an error if:
+ * - The token is not registered in the container.
+ * - A circular dependency is detected. Use {@link injectBy} if resolving
+ *   circular dependencies is necessary.
  */
 declare function inject<Value>(token: Token<Value>, name?: string): Value;
 /**
@@ -832,7 +868,7 @@ declare function inject<Value>(token: Token<Value>, name?: string): Value;
  * Throws an error if the class is not registered in the container.
  *
  * Compared to {@link inject}, `injectBy` accepts a `thisArg` argument
- * (the containing class) which is used to resolve circular dependencies.
+ * (e.g., the containing class instance) which is used to resolve circular dependencies.
  *
  * @example
  * ```ts
@@ -856,7 +892,7 @@ declare function injectBy<Instance extends object>(thisArg: any, Class: Construc
  * Throws an error if the token is not registered in the container.
  *
  * Compared to {@link inject}, `injectBy` accepts a `thisArg` argument
- * (the containing class) which is used to resolve circular dependencies.
+ * (e.g., the containing class instance) which is used to resolve circular dependencies.
  *
  * @example
  * ```ts
@@ -878,13 +914,17 @@ declare function injectBy<Value>(thisArg: any, token: Token<Value>, name?: strin
 /**
  * Injects all instances provided by the registrations associated with the given class.
  *
- * Throws an error if the class is not registered in the container.
+ * Throws an error if:
+ * - The class is not registered in the container.
+ * - A circular dependency is detected.
  */
 declare function injectAll<Instance extends object>(Class: Constructor<Instance>): Instance[];
 /**
  * Injects all values provided by the registrations associated with the given token.
  *
- * Throws an error if the token is not registered in the container.
+ * Throws an error if:
+ * - The token is not registered in the container.
+ * - A circular dependency is detected.
  */
 declare function injectAll<Value>(token: Token<Value>): Value[];
 
@@ -1044,11 +1084,17 @@ declare function applyMiddleware(container: Container, middlewares: Middleware[]
 /**
  * Injects the instance associated with the given class,
  * or `undefined` if the class is not registered in the container.
+ *
+ * Throws an error if a circular dependency is detected.
+ * Use {@link optionalBy} if resolving circular dependencies is necessary.
  */
 declare function optional<Instance extends object>(Class: Constructor<Instance>, name?: string): Instance | undefined;
 /**
  * Injects the value associated with the given token,
  * or `undefined` if the token is not registered in the container.
+ *
+ * Throws an error if a circular dependency is detected.
+ * Use {@link optionalBy} if resolving circular dependencies is necessary.
  */
 declare function optional<Value>(token: Token<Value>, name?: string): Value | undefined;
 /**
@@ -1056,7 +1102,7 @@ declare function optional<Value>(token: Token<Value>, name?: string): Value | un
  * or `undefined` if the class is not registered in the container.
  *
  * Compared to {@link optional}, `optionalBy` accepts a `thisArg` argument
- * (the containing class) which is used to resolve circular dependencies.
+ * (e.g., the containing class instance) which is used to resolve circular dependencies.
  *
  * @param thisArg - The containing instance, used to help resolve circular dependencies.
  * @param Class - The class to resolve.
@@ -1068,7 +1114,7 @@ declare function optionalBy<Instance extends object>(thisArg: any, Class: Constr
  * or `undefined` if the token is not registered in the container.
  *
  * Compared to {@link optional}, `optionalBy` accepts a `thisArg` argument
- * (the containing class) which is used to resolve circular dependencies.
+ * (e.g., the containing class instance) which is used to resolve circular dependencies.
  *
  * @param thisArg - The containing instance, used to help resolve circular dependencies.
  * @param token - The token to resolve.
@@ -1079,11 +1125,15 @@ declare function optionalBy<Value>(thisArg: any, token: Token<Value>, name?: str
 /**
  * Injects all instances provided by the registrations associated with the given class
  * or an empty array if the class is not registered in the container.
+ *
+ * Throws an error if a circular dependency is detected.
  */
 declare function optionalAll<Instance extends object>(Class: Constructor<Instance>): Instance[];
 /**
  * Injects all values provided by the registrations associated with the given token
  * or an empty array if the token is not registered in the container.
+ *
+ * Throws an error if a circular dependency is detected.
  */
 declare function optionalAll<Value>(token: Token<Value>): Value[];
 

package/dist/cjs/index.js

@@ -337,7 +337,6 @@ const Scope = {
    */ Container: "Container"
 };
 
-// @internal
 // @__NO_SIDE_EFFECTS__
 function createType(typeName, provider, options) {
     const name = `Type<${typeName}>`;
@@ -1008,6 +1007,7 @@ function isDisposable(value) {
     };
 }
 
+// @__NO_SIDE_EFFECTS__
 function forwardRef(token) {
     return {
         getRefTokens: ()=>{
@@ -1083,6 +1083,7 @@ function describeParam(target, methodKey, parameterIndex) {
     return `${location}(parameter #${parameterIndex})`;
 }
 
+// @__NO_SIDE_EFFECTS__
 function Inject(token) {
     return function(target, propertyKey, parameterIndex) {
         updateParameterMetadata("Inject", target, propertyKey, parameterIndex, (dependency)=>{
@@ -1093,9 +1094,8 @@ function Inject(token) {
     };
 }
 
-/**
- * @__NO_SIDE_EFFECTS__
- */ function Injectable(...args) {
+// @__NO_SIDE_EFFECTS__
+function Injectable(...args) {
     return function(Class) {
         const metadata = getMetadata(Class);
         const arg0 = args[0];
@@ -1113,6 +1113,7 @@ function Inject(token) {
     };
 }
 
+// @__NO_SIDE_EFFECTS__
 function InjectAll(token) {
     return function(target, propertyKey, parameterIndex) {
         updateParameterMetadata("InjectAll", target, propertyKey, parameterIndex, (dependency)=>{
@@ -1165,6 +1166,7 @@ function InjectAll(token) {
     };
 }
 
+// @__NO_SIDE_EFFECTS__
 function Optional(token) {
     return function(target, propertyKey, parameterIndex) {
         updateParameterMetadata("Optional", target, propertyKey, parameterIndex, (dependency)=>{
@@ -1175,6 +1177,7 @@ function Optional(token) {
     };
 }
 
+// @__NO_SIDE_EFFECTS__
 function OptionalAll(token) {
     return function(target, propertyKey, parameterIndex) {
         updateParameterMetadata("OptionalAll", target, propertyKey, parameterIndex, (dependency)=>{