From b3838976f4cbc0b087cc2edf681f4db7b784403d Mon Sep 17 00:00:00 2001 From: mkloubert Date: Wed, 31 Jan 2024 12:10:55 +0000 Subject: [PATCH] Publish 'docs' to 'gh-pages' in 'egomobile/node-documentation' --- assets/search.js | 2 +- functions/DependsOn.html | 2 +- functions/getDependencies.html | 2 +- functions/setDependencies.html | 2 +- interfaces/IClassDependencyItem.html | 6 +++--- interfaces/IDependencyInformation.html | 18 ++++++++++-------- interfaces/IDependencyInformationEntity.html | 18 ++++++++++-------- .../IDependencyInformationEntityAttribute.html | 16 +++++++++------- interfaces/IDependencyItem.html | 2 +- interfaces/IMethodDependencyItem.html | 6 +++--- interfaces/IParameterDependencyItem.html | 8 ++++---- interfaces/IPropertyDependencyItem.html | 6 +++--- types/DependencyInfoResolver.html | 2 +- types/DependencyInformationEntities.html | 2 +- .../DependencyInformationEntityAttributes.html | 2 +- types/DependencyItem.html | 2 +- types/DependencyItemCollectionResolver.html | 2 +- types/DependencyItemWithInfo.html | 2 +- variables/defaultDependencies.html | 2 +- 19 files changed, 54 insertions(+), 48 deletions(-) diff --git a/assets/search.js b/assets/search.js index 4527b01..f5ec34a 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VZTY/bNhD9L9wr4TU/JFu+FWkOAVq06KE9CItAselYiCUZEnfTxWL/e0FZtjjaGX3ZPRnJzrx5fI8zoqg3VhY/K7aJ39iPNN+xTag5y5PMsA37buyv5mTyncm3qakYZ8/lkW3Y/jnf2rTIq8dOxOJgsyPjbHtMqspUbMPYO0eAq0Hgah7wOaf6I0cgr3/rBZPLaCUC2UE0+fb1S74vyixxYJ9zm1qfuH09mUsFIvZOVV9/sbZMvz3bCdW9nBtY/GWq4vhiyt6yl6B+w4JAhdcqX786oPGoD9cED5yzU1Ka3NKsRy3TmowmYk02Vz5rsk/F8WjqrTgsJBp+R0lp/Ani4msaK8c/qT04f3pJXoL6ZQ/ahX/55CIIQ9PcmnKfbE31iMX1FhFL2U6ZbZFXtnze2qKcBP4AE3GF0SUQRIDLoxj0mjtQGgiNThuUCxo5XuzkdJoI+3BOIdaIE6ecTqz5XpSvUxl4efegcUiq34ptcvy835utraay+Zh+J1J/maywZj6rbv49aJnus3kkHS/vHjRKkyXlj8ks2rR7kCDnQw+D/gkxVH54RpxPJONZneMnzIuP56MpNR5A/hQVmoXdbZL4pGbOk35Ks6eKz+y22TJIcOaE6TC8Zc70U/xhZjp6Trwfkcnzxiczb+r0E5o2e3w2MybQBypj59D1zWgq1WvihGPjzBEAS902C9r1/j9DocP1HtNhDOWbxsRHzrfPi0HSMwZHh+fcCTJIbeYo6dC7ZaYMUpwzXDr8Zk8ZjBw1bqjXzym3Cj7078Yeit2IAljg+ElFbU4StX8zoqynOkvX7ndyoDiQ98+kTDJjTTlCYSL2dpH7gPt1pugTBNJ8Z/6dTuGSdh8SpN+9HPotH6YAXS+Lkynt6xjT0dA7eE7jDliOc58sdk/9Aa2HCKj2BnBn9snzEb/6f0nKNPl2NNUjEoUJ/MSbDbx5Yy+mrNx76IbJhVpEjLN9ao4791njXJuzbZFljvJT87e/jbuFcxHnkMcl4/GSq2CxDMOnJx5fMuo/1P9RhwnGY4GFCRAmGY8lFiZBmGI8VliYAmGa8VhjYRqEBYzHARYWgLCQ8TjkMlpEwQqEhSBsxXi8wtBWIGzNeLzGwtYgLKKKRlBep3aE6tvxoTYCNUxAK4STXOCeQTeEU11ILtaLaCVgJDREOOEF6pyAnginvUDNE9AW4eQXAZfhIogUjITOCOeACNFIaI5wJogVGgn9Ec4HgRopoEXSGSEiDFNCj6Qg9ZSddqn7BXVTQo+kM0KibkrokdSknhJ6JANSTwk9kiGpp4QeSWeElFzKxXLViYQeyTWtJ/RIRrSe0CPljJD4ZIEeKUGqpKBHSpIqqc5UU6RKCnqkNKmSgh6pgFRJQY9USKqkoEeq9gjtTQU9Us4Iic5WBT1SEb0i6JFekjw19Eg7I2SIPgCgR1qS1TX0SNd9hM533Xn4aJon9Eg7IyQ6QzT0SIc0T+iRXtHVoUe69gh9duizR/WR4cWU1uy+nI8OcXz9VvrGvjbnievR8I2FbPP2zlnkft7bQ4T7l8OvPzS1iUK3mSKgcrz75TZVijZVKiK1vfnxagZezYau1OdfJSgg/zukh+WREJLIbY5nO3CI8xYStRh6TWJcDoupe7u+fg9vYbxVUUJ2QM6v6O1XnBZLtViUsjTWK+6X57QexqxfJ9rkVZu8GpW8vX5nx7Rat3AjBLcm+5naQ1p/e29BPNvEshelct95PcO9jUvkYaYIj7Wg+uu7IffZsk2n6B6S6uguH83lHs+r7vW4WDVdEzRdQy3jkFRlfTGIAXqeinUD2LSjonZdWr/P0PtEeIsUVC+n6N4FMF4DCGq34jCm+Vjn2e1xkpRSfWBJe+Puofo9SvmZ0kpJrx8V1VNpVl8F9aB4U0dRrdRcf3hZnvWatPp0uZPoKe9tSk3afWpeuHtwvNbS1PSsbxW8HL+Nm4ZQl8dIdP7VsvkNCczrla+397y5IpdNXzT9oShuFd32/hOKyO4+zoW3NKEaCqL5bZammlbVDUXdLF2je+mJs1N6Msc0N2wTP72//wd7VgIBRSkAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VaTW/jNhT8L8xVcMwPSZZvi+0eArRosYf2IAQLrU3HQmzJkJRsgyD/vaBMW3zKe/qyegp2/d5wOEOOaMrvrMh/lWwdv7PnNNuydaA8liVHzdbsSVe/6ZPOtjrbpLpkHnspDmzNdi/ZpkrzrLxvVSz21fHAPLY5JGWpS7Zm7MNDgMte4HIa8Lmn/DNDIK+fdYKJZRRyX7QQdbZ5e8h2eXFMDNi3rEorl3j1dtKXEYjamUZ9+1JVRfrzpRoxutNzA4vvuswPr7roHPZS1G2Y78vgOsqPHwZoOOrdtcEB99gpKXRW0awHTbPSR5pIpY9T5av08Wt+OOh6KfYLiZbPKCmNP0JcfE5D5fgnrfbGn06Sl6Ju2f1m4g9fTQVhaJpVutglG13eY3Wdg/ClaFJmk2dlVbxsqrwYBX4HG3GF0SkQRIDLgxh0mtszNBAaTRuUC1o5XOzkdBoJe3duIeaIE6ecTir9lBdvYxk4fXPQ2Cfl7/kmOXzb7fSmKsey+dw+E6nv+phXejqrdv8ctHT72TyQjtM3B41C73Shs814IqBzHirHpHiewOPSNgcJMqo6GHSHVd/w/XF1PhwNZ3WuHxFdn49qY8a4A/1jVLATmy3UXFITo62b0uSAc5ndFnO9BCeGXYvhLZHXTfFZT3T03DgfkSnR5/KZHIB9tEbGIOQ0JQy7CY2LRJfNhGD8RGVoPF6/O46lem0ccbCemExwqNsiqpnv/5NVLa5zhNYQyjel12fOt8dYL+kJedbiOTXYeqlNT7gWwxujbgDRSZn3ieX08OulOCUFW/wmxyFGjspF6iZhzAWRC/2Hrvb5dsAAWOHwSKV2EYnavWtQ1mOdpcfudrJncCDvX0mRHHWliwEKE7W3i9wF3K0zRZ8gkGZb/e94Cpe2eUiQfndy6La8nwJ0vchPuqjehpiOls7gOY3bYznOfbTYHeP3aN1HQDaXuVu9S14O+Fuc16RIk58HXd4jVZjAj55dwOt39qqL0nyPXzOxkIuIeWyX6sPWvKE6j+2xTX48GsqP9rO/tblQNRXnkvsl8+KlJ/1FoFaPj1586ag/qP+jLuPMizlWxkGZYF4ssDIByiTzYomVSVCmmBcrrEyBMp95sY+V+aAsYF4ceHK58BWoCkBVyLw4xMBCULZiXrzCylagLCLGjKC4RusIVbflQm0DaheHRnAjOMcdg15wozkXHo8Wfoslh3ZwIztHfePQEW6U56h1HJrCjfrc90S44KEPK6Ex3BjAA7QSesONBzxEK6E93PjAUR85tEgYI3iEYQrokTBGiCVa2dosglReQI+EMUKgbgrokTBGCHwLQo+ETyovoEciIJUX0CMRksoL6JEwRgjpCbEI/FYl9EhEtPLQI7kklZfQI8lJ5SX0SNaJhq5k2co0SeopoUdSkXpK6JH0ST0l9EgGpJ4SeiRDUk8JPZIrWk/okYxoPaFHqvYITWsFPVL1PgrQSuiREuTcFfRI0VmnWo+eeh+hDwIFPVI+PTr0SNUeoWmjoEcqpHlCj1TtEfrsUNAjFdE8oUf+khzdhx75xgiJPo/8s0f1ceVVF5XePpyPLXF8feX+zn7Ys8z1WPrOArZ+//BYZP58NAcY8y+DX7+vbBq5ajq5T/U47waaViGaVqGI1uZ6zBnTd8a0dIV//islBeS+znawuIMliF57NNyCA2SDIZcNhs9JjMtBNTXf7K8/q2hgnFlRQrZAztcDzctAh1KDRQlCY73hfjlOU245mPVXmaY5bJrDQc2b6881MK1WDdxqENyvtNqn9U84GpDIsX7ZiVKanws4K9dZuEQfZgp3WHNqfz1pcp05y4yiu0/Kg7mh1ZfLTmd0Z4/z0O4au3skZeg+KYv69hQDdDzlKwtogSW1gtP6uxS9TrgzSU7tpRRduwDG2QCcmhwOo+2LVsduJyMEtZ26wJLmtYSD6uwnSS2jlFZKOHmhqPWQHutrqA4UZ1UoUu/z1YvT5axkFVBdp8t9SMfwzhpSpE8n+2W/A8fZy4pKhPpGw+lx1oiw61faDaGE/WsfK4raru6luLP8HDpiabdGZIeg8u96c+1QdHaD4Lbf4klqmiWdIO7Djuhunwy4E3Zc2qlYdeSFkp2asp8rmwI+uiwfPXZKT/qQZpqt48ePj/8AMpcom9crAAA="; \ No newline at end of file diff --git a/functions/DependsOn.html b/functions/DependsOn.html index fbb8ec0..738b503 100644 --- a/functions/DependsOn.html +++ b/functions/DependsOn.html @@ -5,4 +5,4 @@

Returns any

The new decorator function.

Example

import {
    defaultDependencies,
    DependsOn
} from "@egomobile/documentation"

@DependsOn({
 // an unique ID of the "remote" app that
  // has a dependency on this class
  app: "id-of-my-app",

  // optional remarks for this app
  remarks: "Changes made by this class will update entities in this app",

  // list of entities that are
  // affected in `app`
  entities: [
    {
      // an unique ID of the entity in `app`
      // like the name of a database table
      // or collection
      key: "tdta_user",

      // optional remarks for this entity
      remarks: "Changes made by this class will update this entity",

      // list of entities that are
      // affected in that entity
      attributes: [
        {
          // an unique ID of the attribute
          // inside the entity in like the name of
          // column
          key: "email",

          // optional remarks for this entity attribute
          remarks: "Changes made by this class will update this attribute",
        },
      ],
    },
  ],
})
class MyDocumentedClass {
    // you can also save information
    // about a property
   @DependsOn({ ... })
    public aProp: any

    // you can also save information
    // about a method
    @DependsOn({ ... })
    public aMethod(
        // you can also save information
        // about a method parameter
        @DependsOn({ ... }) aParam: any
    ) {
        // ...
    }
}

console.log(
    // by default all information are
    // stored in this module-wide array
    defaultDependencies
)
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getDependencies.html b/functions/getDependencies.html index 05b1abb..7e2b600 100644 --- a/functions/getDependencies.html +++ b/functions/getDependencies.html @@ -2,4 +2,4 @@

Returns Collection<DependencyItemWithInfo>

The current, global collection of DependencyItemWithInfos.

Example

import {
  getDependencies,
  setDependencies
} from "@egomobile/documentation"

// initially this is an array
console.log(
  getDependencies()
)

// you can also define a function that returns the collection
const newDependencyCollection = new Set<DependencyItemWithInfo>()

setDependencies(newDependencyCollection)

// should be the set from `newDependencyCollection` now
console.log(
  getDependencies()
)
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/setDependencies.html b/functions/setDependencies.html index 31b3fae..7842c52 100644 --- a/functions/setDependencies.html +++ b/functions/setDependencies.html @@ -2,4 +2,4 @@

Parameters

Returns void

Example

import {
  getDependencies,
  setDependencies
} from "@egomobile/documentation"

// initially this is an array
console.log(
  getDependencies()
)

// you can also define a function that returns the collection
const newDependencyCollection = new Set<DependencyItemWithInfo>()

setDependencies(newDependencyCollection)

// should be the set from `newDependencyCollection` now
console.log(
  getDependencies()
)
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IClassDependencyItem.html b/interfaces/IClassDependencyItem.html index bf5ceab..e6ddbf7 100644 --- a/interfaces/IClassDependencyItem.html +++ b/interfaces/IClassDependencyItem.html @@ -1,6 +1,6 @@ IClassDependencyItem | @egomobile/documentation

Interface IClassDependencyItem

A IDependencyItem with information about a class and its dependencies.

-
interface IClassDependencyItem {
    constructor: Constructor<any>;
    type: "class";
}

Hierarchy (view full)

Properties

constructor +
interface IClassDependencyItem {
    constructor: Constructor<any>;
    type: "class";
}

Hierarchy (view full)

Properties

constructor type

Properties

constructor

constructor: Constructor<any>

The underlying constructor.

-

type

type: "class"

The type

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

type

type: "class"

The type

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IDependencyInformation.html b/interfaces/IDependencyInformation.html index 68e4c54..3254684 100644 --- a/interfaces/IDependencyInformation.html +++ b/interfaces/IDependencyInformation.html @@ -1,20 +1,22 @@ IDependencyInformation | @egomobile/documentation

Interface IDependencyInformation

Information about a dependency.

-
interface IDependencyInformation {
    app: ReferenceValue;
    category?: Nilable<string>;
    entities?: Nilable<DependencyInformationEntities>;
    hasLocalEffects?: Nilable<boolean>;
    hasRemoteEffects?: Nilable<boolean>;
    remarks?: Nilable<string>;
    type?: Nilable<string>;
}

Properties

app +
interface IDependencyInformation {
    app: ReferenceValue;
    category?: Nilable<string>;
    entities?: Nilable<DependencyInformationEntities>;
    hasLocalEffects?: Nilable<boolean>;
    hasRemoteEffects?: Nilable<boolean>;
    references?: Nilable<string[]>;
    remarks?: Nilable<string>;
    type?: Nilable<string>;
}

Properties

app category? entities? hasLocalEffects? hasRemoteEffects? +references? remarks? type?

Properties

app

app: ReferenceValue

A reference value. Value should be handled as slug value, case-insensitive.

-

Optional category

category?: Nilable<string>

An optional value that categories this app. Value should be handled as slug value, case-insensitive.

-

Optional entities

entities?: Nilable<DependencyInformationEntities>

Optional entities for this app.

-

Optional hasLocalEffects

hasLocalEffects?: Nilable<boolean>

If there is an action on app's side, it will +

Optional category

category?: Nilable<string>

An optional value that categories this app. Value should be handled as slug value, case-insensitive.

+

Optional entities

entities?: Nilable<DependencyInformationEntities>

Optional entities for this app.

+

Optional hasLocalEffects

hasLocalEffects?: Nilable<boolean>

If there is an action on app's side, it will have effects in this application in general.

Default

false

-

Optional hasRemoteEffects

hasRemoteEffects?: Nilable<boolean>

If there is an action in this application, +

Optional hasRemoteEffects

hasRemoteEffects?: Nilable<boolean>

If there is an action in this application, it will have effects on app's side in general.

Default

true

-

Optional remarks

remarks?: Nilable<string>

Optional notes/remarks for this app. Should be handled as Markdown, if possible.

-

Optional type

type?: Nilable<string>

An optional value that classifies the application. Value should be handled as slug value, case-insensitive.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional references

references?: Nilable<string[]>

An optional list of references. Should be handled as URIs.

+

Optional remarks

remarks?: Nilable<string>

Optional notes/remarks for this app. Should be handled as Markdown, if possible.

+

Optional type

type?: Nilable<string>

An optional value that classifies the application. Value should be handled as slug value, case-insensitive.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IDependencyInformationEntity.html b/interfaces/IDependencyInformationEntity.html index b1c914d..3dcb379 100644 --- a/interfaces/IDependencyInformationEntity.html +++ b/interfaces/IDependencyInformationEntity.html @@ -1,20 +1,22 @@ IDependencyInformationEntity | @egomobile/documentation

Interface IDependencyInformationEntity

An entity inside a IDependencyInformation object.

-
interface IDependencyInformationEntity {
    attributes?: Nilable<DependencyInformationEntityAttributes>;
    category?: Nilable<string>;
    hasLocalEffects?: Nilable<boolean>;
    hasRemoteEffects?: Nilable<boolean>;
    key: ReferenceValue;
    remarks?: Nilable<string>;
    type?: Nilable<string>;
}

Properties

attributes? +
interface IDependencyInformationEntity {
    attributes?: Nilable<DependencyInformationEntityAttributes>;
    category?: Nilable<string>;
    hasLocalEffects?: Nilable<boolean>;
    hasRemoteEffects?: Nilable<boolean>;
    key: ReferenceValue;
    references?: Nilable<string[]>;
    remarks?: Nilable<string>;
    type?: Nilable<string>;
}

Properties

attributes? category? hasLocalEffects? hasRemoteEffects? key +references? remarks? type?

Properties

Optional attributes

attributes?: Nilable<DependencyInformationEntityAttributes>

Optional list of attributes.

-

Optional category

category?: Nilable<string>

An optional value that categories this entity. Value should be handled as slug value, case-insensitive.

-

Optional hasLocalEffects

hasLocalEffects?: Nilable<boolean>

If there is an action on this entity side, it will +

Optional category

category?: Nilable<string>

An optional value that categories this entity. Value should be handled as slug value, case-insensitive.

+

Optional hasLocalEffects

hasLocalEffects?: Nilable<boolean>

If there is an action on this entity side, it will have effects in this application in general.

Default

false

-

Optional hasRemoteEffects

hasRemoteEffects?: Nilable<boolean>

If there is an action in this application, +

Optional hasRemoteEffects

hasRemoteEffects?: Nilable<boolean>

If there is an action in this application, it will have effects only on entity's side in general.

Default

true

-

key

key: ReferenceValue

The unique key. Value should be handled case-insensitive.

-

Optional remarks

remarks?: Nilable<string>

Optional notes/remarks for this entity. Should be handled as Markdown, if possible.

-

Optional type

type?: Nilable<string>

An optional value that classifies the entity. Value should be handled as slug value, case-insensitive.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

key

key: ReferenceValue

The unique key. Value should be handled case-insensitive.

+

Optional references

references?: Nilable<string[]>

An optional list of references. Should be handled as URIs.

+

Optional remarks

remarks?: Nilable<string>

Optional notes/remarks for this entity. Should be handled as Markdown, if possible.

+

Optional type

type?: Nilable<string>

An optional value that classifies the entity. Value should be handled as slug value, case-insensitive.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IDependencyInformationEntityAttribute.html b/interfaces/IDependencyInformationEntityAttribute.html index ebfe158..0d0a79e 100644 --- a/interfaces/IDependencyInformationEntityAttribute.html +++ b/interfaces/IDependencyInformationEntityAttribute.html @@ -1,18 +1,20 @@ IDependencyInformationEntityAttribute | @egomobile/documentation

Interface IDependencyInformationEntityAttribute

An attribute inside a IDependencyInformationEntity object.

-
interface IDependencyInformationEntityAttribute {
    category?: Nilable<string>;
    hasLocalEffects?: Nilable<boolean>;
    hasRemoteEffects?: Nilable<boolean>;
    key: ReferenceValue;
    remarks?: Nilable<string>;
    type?: Nilable<string>;
}

Properties

category? +
interface IDependencyInformationEntityAttribute {
    category?: Nilable<string>;
    hasLocalEffects?: Nilable<boolean>;
    hasRemoteEffects?: Nilable<boolean>;
    key: ReferenceValue;
    references?: Nilable<string[]>;
    remarks?: Nilable<string>;
    type?: Nilable<string>;
}

Properties

category? hasLocalEffects? hasRemoteEffects? key +references? remarks? type?

Properties

Optional category

category?: Nilable<string>

An optional value that categories this attribute. Value should be handled as slug value, case-insensitive.

-

Optional hasLocalEffects

hasLocalEffects?: Nilable<boolean>

If there is an action on this attribute side, it will +

Optional hasLocalEffects

hasLocalEffects?: Nilable<boolean>

If there is an action on this attribute side, it will have effects in this application in general.

Default

false

-

Optional hasRemoteEffects

hasRemoteEffects?: Nilable<boolean>

If there is an action in this application, +

Optional hasRemoteEffects

hasRemoteEffects?: Nilable<boolean>

If there is an action in this application, it will have effects only on attribute's side in general.

Default

true

-

key

key: ReferenceValue

The unique key. Value should be handled as slug value, case-insensitive.

-

Optional remarks

remarks?: Nilable<string>

Optional notes/remarks for this attribute. Should be handled as Markdown, if possible.

-

Optional type

type?: Nilable<string>

An optional value that classifies the attribute. Value should be handled as slug value, case-insensitive.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

key

key: ReferenceValue

The unique key. Value should be handled as slug value, case-insensitive.

+

Optional references

references?: Nilable<string[]>

An optional list of references. Should be handled as URIs.

+

Optional remarks

remarks?: Nilable<string>

Optional notes/remarks for this attribute. Should be handled as Markdown, if possible.

+

Optional type

type?: Nilable<string>

An optional value that classifies the attribute. Value should be handled as slug value, case-insensitive.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IDependencyItem.html b/interfaces/IDependencyItem.html index effc29c..b18fe64 100644 --- a/interfaces/IDependencyItem.html +++ b/interfaces/IDependencyItem.html @@ -1,2 +1,2 @@ IDependencyItem | @egomobile/documentation

Interface IDependencyItem

A basic dependency item.

-
interface IDependencyItem {}

Hierarchy (view full)

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +
interface IDependencyItem {}

Hierarchy (view full)

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IMethodDependencyItem.html b/interfaces/IMethodDependencyItem.html index 4b38d31..f3defaa 100644 --- a/interfaces/IMethodDependencyItem.html +++ b/interfaces/IMethodDependencyItem.html @@ -1,6 +1,6 @@ IMethodDependencyItem | @egomobile/documentation

Interface IMethodDependencyItem

A IDependencyItem with information about a class method and its dependencies.

-
interface IMethodDependencyItem {
    key: ClassPropKey;
    type: "method";
}

Hierarchy (view full)

Properties

key +
interface IMethodDependencyItem {
    key: ClassPropKey;
    type: "method";
}

Hierarchy (view full)

Properties

key type

Properties

key

key: ClassPropKey

The key / name.

-

type

type: "method"

The type.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

type

type: "method"

The type.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IParameterDependencyItem.html b/interfaces/IParameterDependencyItem.html index ac39c77..05c8594 100644 --- a/interfaces/IParameterDependencyItem.html +++ b/interfaces/IParameterDependencyItem.html @@ -1,8 +1,8 @@ IParameterDependencyItem | @egomobile/documentation

Interface IParameterDependencyItem

A IDependencyItem with information about a paremeter of a class method and its dependencies.

-
interface IParameterDependencyItem {
    index: number;
    key?: Optional<ClassPropKey>;
    type: "parameter";
}

Hierarchy (view full)

Properties

index +
interface IParameterDependencyItem {
    index: number;
    key?: Optional<ClassPropKey>;
    type: "parameter";
}

Hierarchy (view full)

Properties

index key? type

Properties

index

index: number

The zero-based index inside the method.

-

Optional key

key?: Optional<ClassPropKey>

The key / name, if available.

-

type

type: "parameter"

The type.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional key

key?: Optional<ClassPropKey>

The key / name, if available.

+

type

type: "parameter"

The type.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IPropertyDependencyItem.html b/interfaces/IPropertyDependencyItem.html index 841f7fe..4ddc5f6 100644 --- a/interfaces/IPropertyDependencyItem.html +++ b/interfaces/IPropertyDependencyItem.html @@ -1,6 +1,6 @@ IPropertyDependencyItem | @egomobile/documentation

Interface IPropertyDependencyItem

A IDependencyItem with information about a class property and its dependencies.

-
interface IPropertyDependencyItem {
    key: ClassPropKey;
    type: "property";
}

Hierarchy (view full)

Properties

key +
interface IPropertyDependencyItem {
    key: ClassPropKey;
    type: "property";
}

Hierarchy (view full)

Properties

key type

Properties

key

key: ClassPropKey

The key / name.

-

type

type: "property"

The type.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

type

type: "property"

The type.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DependencyInfoResolver.html b/types/DependencyInfoResolver.html index f2ac436..e3bb45b 100644 --- a/types/DependencyInfoResolver.html +++ b/types/DependencyInfoResolver.html @@ -1,2 +1,2 @@ DependencyInfoResolver | @egomobile/documentation

Type alias DependencyInfoResolver

DependencyInfoResolver: ((item) => IDependencyInformation)

A function that returns an IDependencyInformation based on a DependencyItem.

-

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DependencyInformationEntities.html b/types/DependencyInformationEntities.html index 2978547..f528abd 100644 --- a/types/DependencyInformationEntities.html +++ b/types/DependencyInformationEntities.html @@ -1,2 +1,2 @@ DependencyInformationEntities | @egomobile/documentation

Type alias DependencyInformationEntities

DependencyInformationEntities: IDependencyInformationEntity[]

Repository of IDependencyInformationEntity grouped by their name.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DependencyInformationEntityAttributes.html b/types/DependencyInformationEntityAttributes.html index 7ae993c..942cf8a 100644 --- a/types/DependencyInformationEntityAttributes.html +++ b/types/DependencyInformationEntityAttributes.html @@ -1,2 +1,2 @@ DependencyInformationEntityAttributes | @egomobile/documentation

Type alias DependencyInformationEntityAttributes

DependencyInformationEntityAttributes: IDependencyInformationEntityAttribute[]

Repository of IDependencyInformationEntityAttribute grouped by their name.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DependencyItem.html b/types/DependencyItem.html index 427df1b..8bcc3da 100644 --- a/types/DependencyItem.html +++ b/types/DependencyItem.html @@ -1,2 +1,2 @@ DependencyItem | @egomobile/documentation

Type alias DependencyItem

DependencyItem: IClassDependencyItem | IMethodDependencyItem | IParameterDependencyItem | IPropertyDependencyItem

An item for dependencies.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DependencyItemCollectionResolver.html b/types/DependencyItemCollectionResolver.html index c9f6993..b488864 100644 --- a/types/DependencyItemCollectionResolver.html +++ b/types/DependencyItemCollectionResolver.html @@ -1,2 +1,2 @@ DependencyItemCollectionResolver | @egomobile/documentation

Type alias DependencyItemCollectionResolver

DependencyItemCollectionResolver: (() => Collection<DependencyItemWithInfo>)

A function that resolves collection of DependencyItemWithInfos.

-

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DependencyItemWithInfo.html b/types/DependencyItemWithInfo.html index 07c923f..5655706 100644 --- a/types/DependencyItemWithInfo.html +++ b/types/DependencyItemWithInfo.html @@ -1,3 +1,3 @@ DependencyItemWithInfo | @egomobile/documentation

Type alias DependencyItemWithInfo

DependencyItemWithInfo: DependencyItem & {
    info: IDependencyInformation;
}

An extension of DependencyItem.

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/defaultDependencies.html b/variables/defaultDependencies.html index c7ccf93..72a6bb6 100644 --- a/variables/defaultDependencies.html +++ b/variables/defaultDependencies.html @@ -1,2 +1,2 @@ defaultDependencies | @egomobile/documentation

Variable defaultDependenciesConst

defaultDependencies: IArrayLike<DependencyItemWithInfo> = []

Default collection of of DependencyItemWithInfos.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file