feat: classDependsOn()

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log (@egomobile/documentation)
 
+## 0.5.0
+
+- add `classDependsOn()` function
+- code cleanup and improvements
+
 ## 0.4.2
 
 - add tools to add function dependencies

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@egomobile/documentation",
-    "version": "0.4.2",
+    "version": "0.5.0",
     "description": "Tools for documenting (TypeScript) code.",
     "main": "lib/index.js",
     "engines": {

src/decorators/DependsOn.ts

@@ -15,7 +15,7 @@
 // You should have received a copy of the GNU Lesser General Public License
 // along with this program. If not, see <http://www.gnu.org/licenses/>.
 
-import type { IDependencyInformation, IParameterDependencyItem, IPropertyDependencyItem, IMethodDependencyItem, IClassDependencyItem, DependencyInfoResolver, DependencyInfoCollectionArg } from "../types";
+import type { IDependencyInformation, IParameterDependencyItem, IPropertyDependencyItem, IMethodDependencyItem, DependencyInfoResolver, DependencyInfoCollectionArg } from "../types";
 import type { ClassPropKey, CreateDependsOnHelpersFunc, Nilable, Optional } from "../types/internal";
 
 /**
@@ -169,12 +169,15 @@ export function DependsOn(
             else if (args.length === 1) {
                 // class
 
-                const newClassItem: IClassDependencyItem = {
-                    "constructor": target,
-                    "type": "class"
-                };
+                const {
+                    classDependsOn
+                } = require("../functions/dependsOn");
 
-                addItem(newClassItem);
+                classDependsOn(
+                    target,
+                    infoOrResolver,
+                    dependenciesOrResolver
+                );
             }
         }
         else {

src/functions/dependsOn.ts

@@ -13,12 +13,85 @@
 // You should have received a copy of the GNU Lesser General Public License
 // along with this program. If not, see <http://www.gnu.org/licenses/>.
 
-import type { DependencyInfoCollectionArg, DependencyInfoResolver, IDependencyInformation, IFunctionDependencyItem } from "../types";
-import type { CreateDependsOnHelpersFunc, Func, Nilable } from "../types/internal";
+import type { DependencyInfoCollectionArg, DependencyInfoResolver, IClassDependencyItem, IDependencyInformation, IFunctionDependencyItem } from "../types";
+import type { Constructor, CreateDependsOnHelpersFunc, Func, Nilable } from "../types/internal";
+
+/**
+ * Adds dependency information for a class.
+ *
+ * @example
+ * ```
+ * import {
+ *   classDependsOn,
+ *   getDependencies
+ * } from "@egomobile/documentation"
+ *
+ * class MyClass {
+ *   // ...
+ * }
+ *
+ * classDependsOn(
+ *   MyClass
+ *   {
+ *     // your information here...
+ *   }
+ * )
+ *
+ * console.log(
+ *   getDependencies()
+ * )
+ * ```
+ *
+ * @param {Constructor<any>} classConstructor The class constructor.
+ * @param {IDependencyInformation|DependencyInfoResolver} infoOrResolver The dependency information or the function that resolves it.
+ * @param {Nilable<DependenciesArg>} [dependenciesOrResolver] The custom collection for the dependency info items or the function that resolves it.
+ */
+export function classDependsOn(
+    classConstructor: Constructor<any>,
+    infoOrResolver: IDependencyInformation | DependencyInfoResolver,
+    dependenciesOrResolver?: Nilable<DependencyInfoCollectionArg>
+) {
+    const createDependsOnHelpers: CreateDependsOnHelpersFunc =
+        require("../utils/internal").createDependsOnHelpers;
+
+    const {
+        addItem
+    } = createDependsOnHelpers(infoOrResolver, dependenciesOrResolver);
+
+    const newClassItem: IClassDependencyItem = {
+        "constructor": classConstructor,
+        "type": "class"
+    };
+
+    addItem(newClassItem);
+}
 
 /**
  * Adds dependency information for a function.
  *
+ * @example
+ * ```
+ * import {
+ *   functionDependsOn,
+ *   getDependencies
+ * } from "@egomobile/documentation"
+ *
+ * function myFunction() {
+ *   // ...
+ * }
+ *
+ * functionDependsOn(
+ *   myFunction
+ *   {
+ *     // your information here...
+ *   }
+ * )
+ *
+ * console.log(
+ *   getDependencies()
+ * )
+ * ```
+ *
  * @param {Func} func The function.
  * @param {IDependencyInformation|DependencyInfoResolver} infoOrResolver The dependency information or the function that resolves it.
  * @param {Nilable<DependenciesArg>} [dependenciesOrResolver] The custom collection for the dependency info items or the function that resolves it.