From d52f084ac92a85fc2a45fdeaea1e5c9ac1f99cad Mon Sep 17 00:00:00 2001 From: mkloubert Date: Wed, 7 Feb 2024 14:33:57 +0000 Subject: [PATCH] Publish 'docs' to 'gh-pages' in 'egomobile/node-documentation' --- assets/search.js | 2 +- functions/DependsOn.html | 2 +- functions/classDependsOn.html | 2 +- functions/functionDependsOn.html | 2 +- functions/getDependencies.html | 2 +- functions/serializeDependencies.html | 2 +- functions/setDependencies.html | 2 +- interfaces/IClassDependencyItem.html | 6 +++--- interfaces/IDependencyInformation.html | 20 +++++++++---------- interfaces/IDependencyInformationEntity.html | 20 ++++++++++--------- ...IDependencyInformationEntityAttribute.html | 16 +++++++-------- interfaces/IDependencyItem.html | 2 +- interfaces/IFunctionDependencyItem.html | 6 +++--- interfaces/IMethodDependencyItem.html | 8 ++++---- interfaces/IParameterDependencyItem.html | 10 +++++----- interfaces/IPropertyDependencyItem.html | 8 ++++---- ...rializableClassDependencyItemWithInfo.html | 8 ++++---- .../ISerializableDependencyItemWithInfo.html | 4 ++-- ...lizableFunctionDependencyItemWithInfo.html | 8 ++++---- ...ializableMethodDependencyItemWithInfo.html | 12 +++++------ ...izableParameterDependencyItemWithInfo.html | 14 ++++++------- ...lizablePropertyDependencyItemWithInfo.html | 12 +++++------ interfaces/IWithClassNameProp.html | 4 ++-- interfaces/IWithClassOrInstanceProp.html | 4 ++-- interfaces/IWithEffectsProps.html | 6 +++--- interfaces/IWithIsStaticProp.html | 4 ++-- interfaces/IWithReferencesProp.html | 4 ++-- interfaces/IWithRemarksProp.html | 4 ++-- interfaces/IWithTypeProp.html | 4 ++-- types/DependencyInfoArg.html | 2 +- types/DependencyInfoCollectionArg.html | 2 +- types/DependencyInfoResolver.html | 2 +- types/DependencyInformationEntities.html | 2 +- ...DependencyInformationEntityAttributes.html | 2 +- types/DependencyItem.html | 2 +- types/DependencyItemCollectionResolver.html | 2 +- types/DependencyItemWithInfo.html | 2 +- types/SerializableDependencyItem.html | 2 +- variables/defaultDependencies.html | 2 +- 39 files changed, 110 insertions(+), 108 deletions(-) diff --git a/assets/search.js b/assets/search.js index a5ef389..dcb6cb1 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7Vc247jNhL9F/lV6ZFI6tZvQTYLDLC7CSaL7IMxGChu9bQwvkHSTLa3Mf++oERbVXIVRcrKk9Ht4uGpOsUjUpb9FjSnP9vgcfsWfKmPT8GjSNIwOJaHKngM3v+n7l5+2pdt+6/yUP3anM5BGHxt9sFjUB+7qnkud1X77jbq4aU77IMw2Ol/Vm3wGATfw8sEcSTUdYbdZZgH8AYOAlOEwblsqmNHEx8J0Bn+0rw/tl153DnkiWM9sx0He0+yuQWYy3+SlqUKPz8/V7uu1WEtywwGuef9Urb/OO3KvRntjr65HWlJGGXAU/lQHU5dtYjLdKg/mZuyv29/68qu3lm7Dga5l702o9xhN2CIJTfE2ZLbh+q5aqrjrmqt2eEw9/ya6zgf6A0aZslywt6a56FsvswleY3xybAf5Ay6GQdYExvpWrL69+vZ7oWXAPd8utcz73oIbmNCLWlc+YEcoiKLE3Gd72/VuTo+Vcfd6/vj8+mn035f7br6dPyx+XyloSdq31kirenZZ5yb5z70D1V72n+rGusUlyDrPGmSyFH9T5+QTrOom+sAWi2GtWuazaHUSvx87OquBmud4jWJvaO4EOn1x65r6j++dh6zgzFLWXTVgZ+uqw534I4NPt9EZPiK7cTjezQWnZNrOfqL2vH5ZCV5CbKXHbpovwNjBIXuR8R5bCpPx7Zrvu66U+MFvsEDGaOlUvA1d5aB3ePtU6NCk8uQ5EJGuhe7PNOXQx52MwxhcqSJc0qXXfX51Lz6MgDj1qBRTY3YkQYYtwaNL5V3IYYha0zucqKxELEda7r26Ye6/aE+vlRN3VVPd5GcP+vYWfIHnvVozmzjLQSZnfya1Pj9t5XX7S58PVKsz1oY3TjtXXTmvXfYArmzHOI9fPh2Q+YzxwaN9zEEk9hqDg1JLfRpOyUvm4Rs/M3STmSxZUJS6xrnLOGF9jlhvKaJ2ikvsVJIdjVDnaPpaauY4xrmaifoZ7GQ3QpGe0PN1W6vJ05f6teBHqeOhU6Hp7rP8sZ81/O+Cb+lJjhL7U43nND8K2zRJYW7/PE2h/WNcjaJ5Y45ob+ydToQX+ShN6zXM9NZyktcdcJ3NXulyHI+y9228bkbB6H//vXY36ZymIIOdbdpzgEtuHbPY7j7Km6b335XaJYAKvU/q+7l9ORQaCrw/jKzqPYik6x9S8zPbS+wz+QuH2jzPGyfZlvX9QxF1AG/lk15qLqqcWgCJtbjE9fjU/Vfb+jNZRijCJeCZzNaKVj70ZMA25JWBvau9KTg0phWNot7c54obs/mdK6a7tWlO8nQ+03KgjvTFjR3766wzD/TFF4EnHrCwmV5S8zRRB3xW9XU5b7+X/nHviI+Arn5qArSdxzr3jNH7tEsn5k2R+uzWq4J+/aVF0V7o91JsV5Dr41BcWw6f8psFy5swHt7z6lqXgVjC7S8NvR21LlG9uErr1OHyTyW6kzm96xWF6LuC3YZUafucyG6fNk6E2e7k9ooO/embfDKnTk7lUdfWnO+pyvnSbr35BKSTh05T3J5Py4hbX/A2485/dz3X0rf+gitZ92pR2vXJs86AXMscTaDmfFrHJF9p5s7Nvukf495OXF196+FVJ0szImqu4stpOpkZI4dsNTLFlJ3tzMn/nc62tL6u5qamwZ3+Zp7Cry1kcdrd2ezDl95o+MwmY9V2DO/yykciHoYxSKibj7hQPQOm1hE3MMlHNjfaxLLau/sES71v88iXBOYPuPNn/Anz3nzgfbH3MdytQZhHA4fkH02B7n2HRnnOsnnqpuBn0S4s58Dbj2A5ajAU/Vcft3T4N/KptYFb98RUa7Md+OdrfaXI0EcB7jCPqOTN418E+MKbgO1gn0Mze758S34VjWtfijzMRAP8qEIwuC5rvZP+pu8lyvR7nQ46OX00bz3e6Uf9dcRQ8i7KAi3UajEQ5F8/BhuLwP6//f/6KPiINzGoYwfilShsBiFiSDcCgJMoCgZhFtJgUkUpoJwqwgwhaKSINwmFFiCwtIg3KZUWIrCsiDcZsScGYrKg3CbU2A5CiuCcFsQYAUura50HJHFnYjQqxATiDGWIdb1jgUJiaWIdcljSUFiMWJd9ViFInoQqcSRWJBYFz5OKEgsSaxLH6dUIBYl1tWPKVlirEus6x/nocweciVwJJYm1hrElDgxVkdoCQS1QAQWR2gJBCWOmKyRfpGQqwRrIySbjcDiCK2AoFQUWBuhFRDUohJYG6EVEJSIAmsjMrYvBBZHaAUEJbfA2gitgKDkFlgb2WuTh1I9qCzDToLFkb04lNwSiyO1BDIKRfqQJymOnJiY5IxHYnGk4qxHYnFkwhqBxOrIlF3fEssjeXkklkdqESTVvxLLI7UIkupfieVRvDwKy6NituoK66MEV3WF5VGSq7qaXGUUW3WF9VEJW3WF9VEpW3WF9VFaBEmtXIXlUTlfTKyPKvhiYoGSiL12Yn2SmCtmguVJBFvMBOuTSLaYCRYo4a88yWQroFWQlLslWJ9EiyApd0uwPEnG1jLB+iQ5zxLrk/T6UD6YYHnSiJ08xfqkMTt5igVKBbf3SrE+ab9Jo0w4xfKkWgNJXqVSLE+a8PlMNmv8+kmxQGnG5oP1SXt7o64AKZYn5ZdPivXJIpZlhvXJYo5lhuXJtAiK2m1kWJ5Mi6DiUBQPRYLtIMP6ZPzyybA+mRZBiVDkDyKfYGJ9Mi2Colwrm2ynMx4S65NpFRS1djOsT1bwmWN9cl6fHOuTxyzNHAuU9wJRzpFjgXJeoBwLlPMC5VignBcoxwLlKXdey7FAecYeZSZHnl4fyrVyrE9esH6QY32KiC1RgfUpeH8rsD6FYEtUYIEKyZWowPoUiitRgeUpenkoyyywOkXKJ47lKfjtW4H1KXI+8cmptGATnx5MIy7z4S0Y2q+gnDpPRZOzadRLRB69osnhNOr32JQdDm/BUK1FQp6No8n5NOpvGVAb2OEtGKrlSMjjcTQ5o0Zaj4QysOEtGKoFScgTcjRo1d/k+VY1XfX0frjZs91ef0LjLfhk7gDF+eV+0lsQ58Hj2/cwEFK/fh/v/Oi/9Bz9TxCMY0U2jhUFNwZ8Q3YcOt7bewskN3T8UheYE/CV0cBXXV5zDkjf/Hoabonp33MY4RIJ0o9S2/jhbhioHBg5zJ+nw2shzSubmMY7NfX1CVBQGJDegJIK85oNr1nMocLf4QAVS4BKXIbm1ukTusEKyiRgmRIW5HLLW39QUurfLALlSgEETwMi7K4/xDLFAinFbmya68/TABjQv3HmBjN892f8CQqAVgA0Tnke7ZVeKCIC6kXzqP2HEmA46FLBNQ4ePladqpkAnSCEE+CfdfcyfHIGYECfC2WFma5YqH3ErXhKIAEEklwtLrfQ6bkVnJvrmM8Vv44iCMDZ7EvZ7vW3MKvLFxgBwDg+GexAGptQxiYSrkleyrbpvxdJwIK1aTxMKgNr4BOuYDUwV7IDQc0Et1Zrcl0gGEBRcKrTMJX5DQlgsmBVyCVg5fgNaYAKelpxzVHzlZKgUglbKdygJA5sEs5p60P/IJgFBRQ84ezMPDkFRoHLc2paKOdHY1NQwFsy096Zuerll2us+X9h2r1g5Ttfngix5AguACm3Guuz+dzYggOcJWUJteDTYWLRUDapgF9knNsiYAdM0KYZ2x4Qk245Ehu0cOZUCKoNSWTQ1LlTJRj9SXDQ67kTbbonSGzQYwW7qtvWPNgwDgQryezLc7MWCrOw9BGKwdNMrrvWc//jmyMyaKp5gHGbOoWBOwEbjLnenIcfBAaVAXZpG38pznR+UFjWbfX48Rv1UwSwbFmPGhD6b7dPh8fwCMBeHzWAPnXdjIZHD858+u/NAaMB0knjgMo4oyrMldp0SWpORalxzJRLcXqwUSCtzFz+MwOeX442BrzgDAT+jAHIGe1/zE7D8FOmqxOuma6/MQDw4LnE1EOaHYwyuAlXW942UTXgATniVL4+j8Pt/BQ8HURciq1l6wibLeIWzM3xHu5YTYGFaRBpXpUpWHIRwNhNahorNe9nRrDscl03f+fm78LEF+Rq/BgG5/pc7etjFTxuP37//n8XABqmMl4AAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7Vc247bRhL9F+qVGZN94WXegmwWMLC7CZxF9kEwDEXD8RDWDSTt7OzA/75oqiVWUVXNbop5ImZUVX2qTvVhN29vUXP8s40e12/Rl/rwFD0KncXRYbOvosfo/X/q7uWn3aZt/7XZV782x1MUR1+bXfQY1Yeuap4326p9d2v18NLtd1Ecbc0/qzZ6jKLv8WWANBHqOsL24hYQeAWdwBBxdNo01aGjgQ8A6Ax/ad4f2m5z2HrkiW0Dsx2cgwdZ3QaYyn+UlqMKPz8/V9uuNWYtiwwa+ef9smn/cdxudtbbP/rq1tORMMqAh/Kh2h+7ahaWsWs4mJuyv29/6zZdvXV2HTTyL3ttvfzDroCLIzeE2ZHbh+q5aqrDtmqd2WEz//yaq19I6BVyc2Q5Qu/Mc79pvkwlebUJybB38g66GhyciQ1wHVn9+/Xk1sKLgX8+3euJVz0UbmVNHWlc8YEckjJPtbiO97fqVB2eqsP29f3h+fjTcbertl19PPzYfL7CMAO17xyWzvTcI06Nc1/0D1V73H2rGucQFyPnOJnWcmD/0yfE02TU1dWBZotB7Ztms98YJn4+dHVXg7lO4RrZ3lFcGOn1x65r6j++dgGjA5+5KLpqzw/XVfs74g4NPt1EpPmC7cTHD2gsOiffcvQntcPz0QnyYuQuO1TRfgXGEArVj7ALWFQeD23XfN12xyYo+Ao7MkJLpRAq7iwCt8a7h0aFJqchiYW09C/25kSfDvmwq7MLkyMNnGN601Wfj81rKALgtwSMaizEnjCA3xIwvlTBhTi7LDG4z47GAcS1renapx/q9of68FI1dVc93QVyeq/jRslveJaDObGMdwBkVvJLQuPX305ct6vw5UCxOutAdKO0d8GZ1t7zEsgf5dk+QIdvF2QhY6yQf4gg2MQWU2gIaqZOuyGFqzWENFOz3ZCClBuiCddvN5DZKg5BLavlk4BnKvoI8ZK67oY8R90h2MU0fgpmoNJjjEvovRtgmOpDdAto/w003zPAdRMcCv3qGLARmim+eKj7VHjIdzntG+GbK4KT0O5UwxHMv0IWfVK4Sx9vc1heKCeTmK+YI/gLS6cH8FkaeoN6OTGdhDxHVUd4F5NXCiyns9yVpJALhDD0378e+itnHkPQpv4yzSmgI65b8xjsoYy7xndfqJoEgEr9z6p7OT55FJoyvL/MbFR3kUnUoSXmx3YXOGRwn3vsPA7XDXbnvJ6AiDrg102z2Vdd1Xg0AWMbcBP48FT9Nzj06uLGMMKlENiMTgjOfgwEwLakE4G7KwMh+DSmE83s3pwGituzOZ6qpnv16U7S9H6RcsSdaAsae3BXOMafaIogAF494cAyvyWmYKKO+K1q6s2u/t/mj11F3JW5uXsG4Xv6+vfMgXtaLGSk1cH5+JhvwqF9FQTR3Wh3QqyX4Gtlo3g2XThktgtnNuC9vedVtaCCsQWaXxt6OepdI7f7wvPUY7CAqTqR+T2z1Qeo/4SdB9Sr+3yAzp+23sDZ7qQWyt696XJeuDMnhwroS2fO93TlNEj/npwD0qsjp0HO78c5oN3PnIchpx9F/0vhO5/qDaw79bTv0uBZJWC2Jd5iMOG/xBY5dLipbXNI+veIlxdWf/2aCdVLwryg+qvYTKheQubZAXO1bCZ0fznzwn+nos2tv6+o+XFwl675p8BLG7m99lc2p/vCCx2PwUKkwp35XUrhATRAKGYB9dMJD6B3yMQs4AEq4YH+XpGYV3tvjfCp/30S4ZvA+LFzfoc/evScN3Q/eT+Uq7URBnf4FNiz3ci170g730E+V91E+JGFP/qpwG1AYDkw8FQ9b77u6ODfNk1tCt6+I6x8kW+HK1vtLwcCODbwDfuMdt505Bsb3+CuoM5gH2O7en58i75VTWueE32MxIN8KKM4eq6r3ZN5ufhyJtoe93sznT7a336vzNsHxuJs8i6J4nUSK/mQqPTjx3h98eh/6P/Rm6VRvE5jKR4SrZFZisxEFK8FFU0gMxnFa0lFk8hMRfFaUdEUMtNRvNZUNI3MsiheZ5RZhszyKF7n1KA5MiuieF1Q0QpkVkbxuqSilbi8ptppQhZ4RETPREqFTDEXqal5KsiYmI7UlD2VZEzMSGoqn6pYJA9SK2yJSUlN8VNNxsS8pKb+aUZaYmpSQ0FKkpNidlLDQlrEMn8opcCWmKDUEJGSFKWYI2GIEORcEZgjYYgQJEdiNF/6CUPPGMyRkGxGAnMkDBGCZFNgjoQhQpAzTGCOhCFCkGwKzJHI2Q4RmCNhiBAk7wJzJAwRguRdYI5kz1ERS/WgswJLC+ZI9hyVVD0l5kgaImQSi+yhVBm2HMma5JRIYoqk4rRIYoakZnVBYoZkxs52iRmSPEMSMyQNDZLsY4kZkoYGSfaxxAwpniGFGVI8QwozpHiGFGZIsQyp0amHZUhhhhTPkMIMKZ4hhRlSPEMKM6R6hsi5rjBDquTrjhnSCVtNjRnSKXvmxQRpwVVTY360ZKupMUFasdXUo+WBZqupMUPa0CBJPdSYIW1okKQeasyQLvhqYoZ0yePEDGU9Q6RyZpihLGVHzzBFmWBHzzBHGbt6yzBFmeFBkrKdYYoyw4MkT27ZaBGX8QlhijJ+EmWYoqxgE8IMZb3KkWuFDDOU83MoxwzlKQszxwzlgoOZY4JyQ4MiFyo5ZijvV9hpLJOHRGFRyDFDOT+JcsxQbmhQIhbFg8xzbDlaaRsaFCleOWYoL/iYmKLc8KDIKZxjioqEzb3AFBU8RQWmqBAszgJzVPQckQJSYI4KnqMCc1TwHBWYo4LnqMAcFTm38StG+yF+Q4QZKnqGSPEqMENlwqpCiRkqU7ZGJWao5GWuxAyVkq1RiRkqFVejEhNUaq5GJean7PkhlbPE/JQ5nzkmqCz4zEd71pLPfLxtTdjrAslo35qkXPLnn6BpP40Kck+WjLauSU8TvX9LRpvXxNChSWE8/wZt+6sK9D47GW1gE8OJJle/59+grWFF03vtZLSJTQwvmhSz82/Q1jCj6f12cmatv3T0rWq66un9+RLSen39Vshb9MleV0qLy1Wqtygtose373EkpDl+H64nmb/MGP23FgZfkQ++ouR8wKvAg+twxfAtkpzr8KoYGBPglckZr7oc2UDmktrT+UKb+XDFEE5LkH6Su/zP19hA5YDnefwiPx9LdT6aWeEIeGzq64OloDIgv3OY7HK09OSCiwq/OAJKpgFNGeNrr8g+oeu2oE4C1okPcrmSbu6/bMzXmUC9MhDCL8L2+smZcSyQUqq9YjXXD/GAMKCBU478UZjzK0XDi9sgWgmica3IR3ulZ4pIAHtcP4Go/b0O4A7aVKRe7kPVqZoJ0AmC60Qc8M+6eznfkANhQJ8L5QwznrKQ+4SrM0WQAARJO2cVV5PLFXoag4IYCibE54qfTwkMwOX/sml35iXP6vJ+JAgw+OtzJtLKhLJHzWX2smmb/rVLIiyYo5kNa8VM2aPmOK+BypKdCGomuDlbk/MDhQEQBVd5Okxlv5oBxBbMDjkn2GZ4ARtEBb2tfKKOKiVBpTSnlDVuUDIObBJO3up9/5yZIwrsCU6A7INZwAucpzPboSXvjcVBAY3JbR/m9uxXCHu0/y9tu5ecEtSnywMnjhzBiSDjZmN9srelHXGAwmQsoBbcfCYmDSWXCuhFzi3PUGCPmKBNc7Y9YEy65cjYoIVzr0JQbUhGBk1deFWC4Z8MDnq98IJN9wQZG/RYyc7qtrXPTQyOYCZd5oA9lvqy0OS0vjZIrsvXU/+50SEyaCp2al4DDMvVcRi4InCFseeb0/kTyKAyQC5d/pfijMcHhWXb2PgPL+yPI4Bpy7J+jtC/PD92T+FewEmF2X7deMM9CNfR/Wt5QGgAddIqorJHbbdD2nZJZpc62UVJOa7HOxwF0srt6b+wwQv7d2mDl1zl4VcSQM5o/WNXGrablT1qrhbXTxiAeHB/Yusgbb7KHjXXXLxsomrAnXLCNfr1cR9u5afgLiHhUmwdS0fYbAm3kLrZ58MVq+VO2P2qtEdlj/pCQGkbxxY0s7/nlvPc2hWX/e/lPG/tS3Lt8zGOTvWp2tWHKnpcf/z+/f/6Bht2JF8AAA=="; \ No newline at end of file diff --git a/functions/DependsOn.html b/functions/DependsOn.html index 8ee0f0b..0ec0f0e 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/classDependsOn.html b/functions/classDependsOn.html index a62f544..384e3f8 100644 --- a/functions/classDependsOn.html +++ b/functions/classDependsOn.html @@ -4,4 +4,4 @@
  • Optional dependenciesOrResolver: Nilable<DependencyInfoCollectionArg>

    The custom collection for the dependency info items or the function that resolves it.

    • Returns void

    Example

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

    class MyClass {
      // ...
    }

    classDependsOn(
      MyClass
      {
        // your information here...
      }
    )

    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/functionDependsOn.html b/functions/functionDependsOn.html index a78d9f0..9454542 100644 --- a/functions/functionDependsOn.html +++ b/functions/functionDependsOn.html @@ -4,4 +4,4 @@
  • Optional dependenciesOrResolver: Nilable<DependencyInfoCollectionArg>

    The custom collection for the dependency info items or the function that resolves it.

    • Returns void

    Example

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

    function myFunction() {
      // ...
    }

    functionDependsOn(
      myFunction
      {
        // your information here...
      }
    )

    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/getDependencies.html b/functions/getDependencies.html index c68218d..72b841c 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/serializeDependencies.html b/functions/serializeDependencies.html index c4aba6e..44fda84 100644 --- a/functions/serializeDependencies.html +++ b/functions/serializeDependencies.html @@ -1,4 +1,4 @@ serializeDependencies | @egomobile/documentation

    Function serializeDependencies

    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 06910c5..57a7085 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 403c7a6..1d4bb1c 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 4655173..2a1bbf5 100644 --- a/interfaces/IDependencyInformation.html +++ b/interfaces/IDependencyInformation.html @@ -1,5 +1,5 @@ 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>;
        key?: Nilable<ReferenceValue>;
        references?: Nilable<string[]>;
        remarks?: Nilable<string>;
        type?: Nilable<string>;
    }

    Hierarchy

    Properties

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

    Hierarchy

    Properties

    app category? entities? hasLocalEffects? @@ -9,16 +9,16 @@ 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 key

    key?: Nilable<ReferenceValue>

    Optional 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. Should be handled as Markdown, if possible.

    -

    Optional type

    type?: Nilable<string>

    An optional value for classification. 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 key

    key?: Nilable<ReferenceValue>

    Optional 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. Should be handled as Markdown, if possible.

    +

    Optional type

    type?: Nilable<string>

    An optional value for classification. 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 22eef2f..4654ba8 100644 --- a/interfaces/IDependencyInformationEntity.html +++ b/interfaces/IDependencyInformationEntity.html @@ -1,6 +1,7 @@ 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;
        references?: Nilable<string[]>;
        remarks?: Nilable<string>;
        type?: Nilable<string>;
    }

    Hierarchy

    Properties

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

    Hierarchy

    Properties

    attributes? category? +entities? hasLocalEffects? hasRemoteEffects? key @@ -8,15 +9,16 @@ 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 app's 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 entities

    entities?: Nilable<DependencyInformationEntities>

    Optional children for this entity.

    +

    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

    -

    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. Should be handled as Markdown, if possible.

    -

    Optional type

    type?: Nilable<string>

    An optional value for classification. 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. Should be handled as Markdown, if possible.

    +

    Optional type

    type?: Nilable<string>

    An optional value for classification. 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 f74034d..b6632d8 100644 --- a/interfaces/IDependencyInformationEntityAttribute.html +++ b/interfaces/IDependencyInformationEntityAttribute.html @@ -1,5 +1,5 @@ IDependencyInformationEntityAttribute | @egomobile/documentation

    Interface IDependencyInformationEntityAttribute

    An attribute inside a IDependencyInformationEntity object.

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

    Hierarchy

    Properties

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

    Hierarchy

    Properties

    category? hasLocalEffects? hasRemoteEffects? key @@ -7,14 +7,14 @@ 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 app's side, it will +

    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

    -

    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. Should be handled as Markdown, if possible.

    -

    Optional type

    type?: Nilable<string>

    An optional value for classification. 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. Should be handled as Markdown, if possible.

    +

    Optional type

    type?: Nilable<string>

    An optional value for classification. 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 0bc59e5..c69ba6c 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/IFunctionDependencyItem.html b/interfaces/IFunctionDependencyItem.html index 49ff958..cfa5ca0 100644 --- a/interfaces/IFunctionDependencyItem.html +++ b/interfaces/IFunctionDependencyItem.html @@ -1,6 +1,6 @@ IFunctionDependencyItem | @egomobile/documentation

    Interface IFunctionDependencyItem

    A IDependencyItem with information about a function and its dependencies.

    -
    interface IFunctionDependencyItem {
        key: string;
        type: "function";
    }

    Hierarchy (view full)

    Properties

    key +
    interface IFunctionDependencyItem {
        key: string;
        type: "function";
    }

    Hierarchy (view full)

    Properties

    key type

    Properties

    key

    key: string

    The key / name.

    -

    type

    type: "function"

    The type.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    type

    type: "function"

    The type.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface IMethodDependencyItem

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

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    classOrInstance? key type

    Properties

    Optional classOrInstance

    classOrInstance?: any

    The underlying class or constructor.

    -

    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 +

    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 diff --git a/interfaces/IParameterDependencyItem.html b/interfaces/IParameterDependencyItem.html index 453c7ae..cfd5841 100644 --- a/interfaces/IParameterDependencyItem.html +++ b/interfaces/IParameterDependencyItem.html @@ -1,10 +1,10 @@ IParameterDependencyItem | @egomobile/documentation

    Interface IParameterDependencyItem

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

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    classOrInstance? index key? type

    Properties

    Optional classOrInstance

    classOrInstance?: any

    The underlying class or constructor.

    -

    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 +

    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 diff --git a/interfaces/IPropertyDependencyItem.html b/interfaces/IPropertyDependencyItem.html index 31709c2..6dbf26d 100644 --- a/interfaces/IPropertyDependencyItem.html +++ b/interfaces/IPropertyDependencyItem.html @@ -1,8 +1,8 @@ IPropertyDependencyItem | @egomobile/documentation

    Interface IPropertyDependencyItem

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

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    classOrInstance? key type

    Properties

    Optional classOrInstance

    classOrInstance?: any

    The underlying class or constructor.

    -

    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 +

    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 diff --git a/interfaces/ISerializableClassDependencyItemWithInfo.html b/interfaces/ISerializableClassDependencyItemWithInfo.html index 2a1bf90..d214f54 100644 --- a/interfaces/ISerializableClassDependencyItemWithInfo.html +++ b/interfaces/ISerializableClassDependencyItemWithInfo.html @@ -1,8 +1,8 @@ ISerializableClassDependencyItemWithInfo | @egomobile/documentation

    Interface ISerializableClassDependencyItemWithInfo

    A serizable version of an IClassDependencyItem.

    -
    interface ISerializableClassDependencyItemWithInfo {
        info: IDependencyInformation;
        name: string;
        type: "class";
    }

    Hierarchy (view full)

    Properties

    info +
    interface ISerializableClassDependencyItemWithInfo {
        info: IDependencyInformation;
        name: string;
        type: "class";
    }

    Hierarchy (view full)

    Properties

    info name type

    Properties

    info

    info: IDependencyInformation

    The underlying information.

    -

    name

    name: string

    The name of the class.

    -

    type

    type: "class"

    The type

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    name

    name: string

    The name of the class.

    +

    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/ISerializableDependencyItemWithInfo.html b/interfaces/ISerializableDependencyItemWithInfo.html index 127d078..f02102a 100644 --- a/interfaces/ISerializableDependencyItemWithInfo.html +++ b/interfaces/ISerializableDependencyItemWithInfo.html @@ -1,4 +1,4 @@ ISerializableDependencyItemWithInfo | @egomobile/documentation

    Interface ISerializableDependencyItemWithInfo

    A serizable version of an IDependencyItem.

    -
    interface ISerializableDependencyItemWithInfo {
        info: IDependencyInformation;
    }

    Hierarchy (view full)

    Properties

    info +
    interface ISerializableDependencyItemWithInfo {
        info: IDependencyInformation;
    }

    Hierarchy (view full)

    Properties

    info

    Properties

    info

    info: IDependencyInformation

    The underlying information.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/ISerializableFunctionDependencyItemWithInfo.html b/interfaces/ISerializableFunctionDependencyItemWithInfo.html index 6863939..c3d42ac 100644 --- a/interfaces/ISerializableFunctionDependencyItemWithInfo.html +++ b/interfaces/ISerializableFunctionDependencyItemWithInfo.html @@ -1,8 +1,8 @@ ISerializableFunctionDependencyItemWithInfo | @egomobile/documentation

    Interface ISerializableFunctionDependencyItemWithInfo

    A serizable version of an IFunctionDependencyItem.

    -
    interface ISerializableFunctionDependencyItemWithInfo {
        info: IDependencyInformation;
        name: string;
        type: "function";
    }

    Hierarchy (view full)

    Properties

    info +
    interface ISerializableFunctionDependencyItemWithInfo {
        info: IDependencyInformation;
        name: string;
        type: "function";
    }

    Hierarchy (view full)

    Properties

    info name type

    Properties

    info

    info: IDependencyInformation

    The underlying information.

    -

    name

    name: string

    The name of the function.

    -

    type

    type: "function"

    The type.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    name

    name: string

    The name of the function.

    +

    type

    type: "function"

    The type.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/ISerializableMethodDependencyItemWithInfo.html b/interfaces/ISerializableMethodDependencyItemWithInfo.html index 8ef7ad8..954041d 100644 --- a/interfaces/ISerializableMethodDependencyItemWithInfo.html +++ b/interfaces/ISerializableMethodDependencyItemWithInfo.html @@ -1,12 +1,12 @@ ISerializableMethodDependencyItemWithInfo | @egomobile/documentation

    Interface ISerializableMethodDependencyItemWithInfo

    A serizable version of an IMethodDependencyItem.

    -
    interface ISerializableMethodDependencyItemWithInfo {
        className: Nullable<string>;
        info: IDependencyInformation;
        isStatic: boolean;
        name: string;
        type: "method";
    }

    Hierarchy (view full)

    Properties

    className +
    interface ISerializableMethodDependencyItemWithInfo {
        className: Nullable<string>;
        info: IDependencyInformation;
        isStatic: boolean;
        name: string;
        type: "method";
    }

    Hierarchy (view full)

    Properties

    className info isStatic name type

    Properties

    className

    className: Nullable<string>

    The name of the underlying class, if available.

    -

    info

    info: IDependencyInformation

    The underlying information.

    -

    isStatic

    isStatic: boolean

    Is underlying type static or not.

    -

    name

    name: string

    The name of the method.

    -

    type

    type: "method"

    The type.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    info

    info: IDependencyInformation

    The underlying information.

    +

    isStatic

    isStatic: boolean

    Is underlying type static or not.

    +

    name

    name: string

    The name of the method.

    +

    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/ISerializableParameterDependencyItemWithInfo.html b/interfaces/ISerializableParameterDependencyItemWithInfo.html index 10ae396..3f288e3 100644 --- a/interfaces/ISerializableParameterDependencyItemWithInfo.html +++ b/interfaces/ISerializableParameterDependencyItemWithInfo.html @@ -1,14 +1,14 @@ ISerializableParameterDependencyItemWithInfo | @egomobile/documentation

    Interface ISerializableParameterDependencyItemWithInfo

    A serizable version of an IParameterDependencyItem.

    -
    interface ISerializableParameterDependencyItemWithInfo {
        className: Nullable<string>;
        index: number;
        info: IDependencyInformation;
        isStatic: boolean;
        name: Nullable<string>;
        type: "parameter";
    }

    Hierarchy (view full)

    Properties

    className +
    interface ISerializableParameterDependencyItemWithInfo {
        className: Nullable<string>;
        index: number;
        info: IDependencyInformation;
        isStatic: boolean;
        name: Nullable<string>;
        type: "parameter";
    }

    Hierarchy (view full)

    Properties

    className index info isStatic name type

    Properties

    className

    className: Nullable<string>

    The name of the underlying class, if available.

    -

    index

    index: number

    The zero-based index inside the method.

    -

    info

    info: IDependencyInformation

    The underlying information.

    -

    isStatic

    isStatic: boolean

    Is underlying type static or not.

    -

    name

    name: Nullable<string>

    The name, if available.

    -

    type

    type: "parameter"

    The type.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: number

    The zero-based index inside the method.

    +

    info

    info: IDependencyInformation

    The underlying information.

    +

    isStatic

    isStatic: boolean

    Is underlying type static or not.

    +

    name

    name: Nullable<string>

    The 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/ISerializablePropertyDependencyItemWithInfo.html b/interfaces/ISerializablePropertyDependencyItemWithInfo.html index ba3bf7b..52b22c1 100644 --- a/interfaces/ISerializablePropertyDependencyItemWithInfo.html +++ b/interfaces/ISerializablePropertyDependencyItemWithInfo.html @@ -1,12 +1,12 @@ ISerializablePropertyDependencyItemWithInfo | @egomobile/documentation

    Interface ISerializablePropertyDependencyItemWithInfo

    A serizable version of an IPropertyDependencyItem.

    -
    interface ISerializablePropertyDependencyItemWithInfo {
        className: Nullable<string>;
        info: IDependencyInformation;
        isStatic: boolean;
        name: string;
        type: "property";
    }

    Hierarchy (view full)

    Properties

    className +
    interface ISerializablePropertyDependencyItemWithInfo {
        className: Nullable<string>;
        info: IDependencyInformation;
        isStatic: boolean;
        name: string;
        type: "property";
    }

    Hierarchy (view full)

    Properties

    className info isStatic name type

    Properties

    className

    className: Nullable<string>

    The name of the underlying class, if available.

    -

    info

    info: IDependencyInformation

    The underlying information.

    -

    isStatic

    isStatic: boolean

    Is underlying type static or not.

    -

    name

    name: string

    The name of the property.

    -

    type

    type: "property"

    The type.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    info

    info: IDependencyInformation

    The underlying information.

    +

    isStatic

    isStatic: boolean

    Is underlying type static or not.

    +

    name

    name: string

    The name of the property.

    +

    type

    type: "property"

    The type.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/IWithClassNameProp.html b/interfaces/IWithClassNameProp.html index 2da6a4c..12d6e16 100644 --- a/interfaces/IWithClassNameProp.html +++ b/interfaces/IWithClassNameProp.html @@ -1,4 +1,4 @@ IWithClassNameProp | @egomobile/documentation

    Interface IWithClassNameProp

    An object with a className property.

    -
    interface IWithClassNameProp {
        className: Nullable<string>;
    }

    Hierarchy (view full)

    Properties

    className +
    interface IWithClassNameProp {
        className: Nullable<string>;
    }

    Hierarchy (view full)

    Properties

    className

    Properties

    className

    className: Nullable<string>

    The name of the underlying class, if available.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/IWithClassOrInstanceProp.html b/interfaces/IWithClassOrInstanceProp.html index e6c0f01..ee71287 100644 --- a/interfaces/IWithClassOrInstanceProp.html +++ b/interfaces/IWithClassOrInstanceProp.html @@ -1,4 +1,4 @@ IWithClassOrInstanceProp | @egomobile/documentation

    Interface IWithClassOrInstanceProp

    An object with a classOrInstance property.

    -
    interface IWithClassOrInstanceProp {
        classOrInstance: any;
    }

    Properties

    classOrInstance +
    interface IWithClassOrInstanceProp {
        classOrInstance: any;
    }

    Properties

    classOrInstance

    Properties

    classOrInstance

    classOrInstance: any

    The underlying class or constructor.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/IWithEffectsProps.html b/interfaces/IWithEffectsProps.html index fc35a0e..36a1a6e 100644 --- a/interfaces/IWithEffectsProps.html +++ b/interfaces/IWithEffectsProps.html @@ -1,10 +1,10 @@ IWithEffectsProps | @egomobile/documentation

    Interface IWithEffectsProps

    An object with effects properties.

    -
    interface IWithEffectsProps {
        hasLocalEffects: Nilable<boolean>;
        hasRemoteEffects: Nilable<boolean>;
    }

    Properties

    hasLocalEffects +
    interface IWithEffectsProps {
        hasLocalEffects: Nilable<boolean>;
        hasRemoteEffects: Nilable<boolean>;
    }

    Properties

    hasLocalEffects hasRemoteEffects

    Properties

    hasLocalEffects

    hasLocalEffects: Nilable<boolean>

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

    Default

    false

    -

    hasRemoteEffects

    hasRemoteEffects: Nilable<boolean>

    If there is an action in this application, +

    hasRemoteEffects

    hasRemoteEffects: Nilable<boolean>

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

    Default

    true

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/IWithIsStaticProp.html b/interfaces/IWithIsStaticProp.html index b837f56..dc5a87b 100644 --- a/interfaces/IWithIsStaticProp.html +++ b/interfaces/IWithIsStaticProp.html @@ -1,4 +1,4 @@ IWithIsStaticProp | @egomobile/documentation

    Interface IWithIsStaticProp

    An object with an isStatic property.

    -
    interface IWithIsStaticProp {
        isStatic: boolean;
    }

    Hierarchy (view full)

    Properties

    isStatic +
    interface IWithIsStaticProp {
        isStatic: boolean;
    }

    Hierarchy (view full)

    Properties

    isStatic

    Properties

    isStatic

    isStatic: boolean

    Is underlying type static or not.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/IWithReferencesProp.html b/interfaces/IWithReferencesProp.html index 7d49137..1837adf 100644 --- a/interfaces/IWithReferencesProp.html +++ b/interfaces/IWithReferencesProp.html @@ -1,4 +1,4 @@ IWithReferencesProp | @egomobile/documentation

    Interface IWithReferencesProp

    An object with a references property.

    -
    interface IWithReferencesProp {
        references: Nilable<string[]>;
    }

    Properties

    references +
    interface IWithReferencesProp {
        references: Nilable<string[]>;
    }

    Properties

    references

    Properties

    references

    references: Nilable<string[]>

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/IWithRemarksProp.html b/interfaces/IWithRemarksProp.html index 5ce53f5..9dff6b3 100644 --- a/interfaces/IWithRemarksProp.html +++ b/interfaces/IWithRemarksProp.html @@ -1,4 +1,4 @@ IWithRemarksProp | @egomobile/documentation

    Interface IWithRemarksProp

    An object with a remarks property.

    -
    interface IWithRemarksProp {
        remarks: Nilable<string>;
    }

    Properties

    remarks +
    interface IWithRemarksProp {
        remarks: Nilable<string>;
    }

    Properties

    remarks

    Properties

    remarks

    remarks: Nilable<string>

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/IWithTypeProp.html b/interfaces/IWithTypeProp.html index 422662a..82d3bb9 100644 --- a/interfaces/IWithTypeProp.html +++ b/interfaces/IWithTypeProp.html @@ -1,4 +1,4 @@ IWithTypeProp | @egomobile/documentation

    Interface IWithTypeProp

    An object with a type property.

    -
    interface IWithTypeProp {
        type: Nilable<string>;
    }

    Properties

    type +
    interface IWithTypeProp {
        type: Nilable<string>;
    }

    Properties

    type

    Properties

    type

    type: Nilable<string>

    An optional value for classification. 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 +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/DependencyInfoArg.html b/types/DependencyInfoArg.html index 9d67f4f..3b1c588 100644 --- a/types/DependencyInfoArg.html +++ b/types/DependencyInfoArg.html @@ -1,2 +1,2 @@ DependencyInfoArg | @egomobile/documentation

    Type alias DependencyInfoArg

    DependencyInfoArg: IDependencyInformation | DependencyInfoResolver

    Type of an infoOrResolver argument.

    -

    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/DependencyInfoCollectionArg.html b/types/DependencyInfoCollectionArg.html index 911b773..79e6729 100644 --- a/types/DependencyInfoCollectionArg.html +++ b/types/DependencyInfoCollectionArg.html @@ -1,2 +1,2 @@ DependencyInfoCollectionArg | @egomobile/documentation

    Type alias DependencyInfoCollectionArg

    DependencyInfoCollectionArg: Collection<DependencyItemWithInfo> | (() => Collection<DependencyItemWithInfo>)

    Type of an dependenciesOrResolver argument.

    -

    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/DependencyInfoResolver.html b/types/DependencyInfoResolver.html index 68ac9aa..82cee19 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 9496d22..7b66f9f 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 188ef16..5b26240 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 e8ec3d0..75d756e 100644 --- a/types/DependencyItem.html +++ b/types/DependencyItem.html @@ -1,2 +1,2 @@ DependencyItem | @egomobile/documentation

    Type alias DependencyItem

    DependencyItem: IClassDependencyItem | IFunctionDependencyItem | 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 b4bc301..313da28 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 47ebfe1..cabaa15 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/types/SerializableDependencyItem.html b/types/SerializableDependencyItem.html index dcfbcc3..a9abea5 100644 --- a/types/SerializableDependencyItem.html +++ b/types/SerializableDependencyItem.html @@ -1,2 +1,2 @@ SerializableDependencyItem | @egomobile/documentation

    Type alias SerializableDependencyItem

    SerializableDependencyItem: ISerializableClassDependencyItemWithInfo | ISerializableFunctionDependencyItemWithInfo | ISerializableMethodDependencyItemWithInfo | ISerializableParameterDependencyItemWithInfo | ISerializablePropertyDependencyItemWithInfo

    An serializable dependency info item.

    -

    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 313e69b..32d1498 100644 --- a/variables/defaultDependencies.html +++ b/variables/defaultDependencies.html @@ -1,2 +1,2 @@ defaultDependencies | @egomobile/documentation

    Variable defaultDependenciesConst

    defaultDependencies: 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