feat: references prop

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log (@egomobile/documentation)
 
+## 0.2.0
+
+- add `references` props to `IDependencyInformation`, `IDependencyInformationEntity` and `IDependencyInformationEntityAttribute`
+
 ## 0.1.1
 
 - [not released yet]

package.json

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

src/decorators/DependsOn.ts

@@ -101,6 +101,10 @@ export interface IDependencyInformation {
      * Optional entities for this app.
      */
     entities?: Nilable<DependencyInformationEntities>;
+    /**
+     * An optional list of references. Should be handled as URIs.
+     */
+    references?: Nilable<string[]>;
     /**
      * Optional notes/remarks for this app. Should be handled as Markdown, if possible.
      */
@@ -141,6 +145,10 @@ export interface IDependencyInformationEntity {
      * The unique key. Value should be handled case-insensitive.
      */
     key: ReferenceValue;
+    /**
+     * An optional list of references. Should be handled as URIs.
+     */
+    references?: Nilable<string[]>;
     /**
      * Optional notes/remarks for this entity. Should be handled as Markdown, if possible.
      */
@@ -177,6 +185,10 @@ export interface IDependencyInformationEntityAttribute {
      * The unique key. Value should be handled as slug value, case-insensitive.
      */
     key: ReferenceValue;
+    /**
+     * An optional list of references. Should be handled as URIs.
+     */
+    references?: Nilable<string[]>;
     /**
      * Optional notes/remarks for this attribute. Should be handled as Markdown, if possible.
      */