From 1cf8cbb5cf7a0355e439523904bb6c9d5147ec51 Mon Sep 17 00:00:00 2001 From: AlexStormwood Date: Sat, 19 Oct 2024 07:11:44 +0000 Subject: [PATCH] Update gh-pages to output generated at bfa25e3 --- assets/navigation.js | 2 +- assets/search.js | 2 +- classes/Classes.CollectionAccessor.html | 14 +-- classes/Classes.CollectionListEntry.html | 10 +- classes/Classes.NedbBaseDocument.html | 40 +++---- classes/Classes.NedbClient.html | 58 +++++----- classes/Classes.NedbDocument.html | 40 +++---- classes/Classes.NedbEmbeddedDocument.html | 40 +++---- classes/Classes.SuperCamo.html | 14 +-- .../Error_Classes.CollectionAccessError.html | 4 +- classes/Error_Classes.DeleteFailure.html | 4 +- classes/Error_Classes.PostDeleteFailure.html | 4 +- classes/Error_Classes.PostSaveFailure.html | 4 +- .../Error_Classes.PostValidationFailure.html | 4 +- classes/Error_Classes.PreDeleteFailure.html | 4 +- classes/Error_Classes.PreSaveFailure.html | 4 +- .../Error_Classes.PreValidationFailure.html | 4 +- classes/Error_Classes.SaveFailure.html | 4 +- classes/Error_Classes.ValidationFailure.html | 4 +- ..._Classes.ValidationFailureMinMaxError.html | 4 +- ...idationFailureMissingValueForProperty.html | 4 +- ...onFailureMissingValueForReferencedDoc.html | 4 +- ...dationFailureReferenceWithoutDatabase.html | 4 +- ...s.ValidationFailureUnexpectedProperty.html | 4 +- ...es.ValidationFailureValueNotInChoices.html | 4 +- documents/Quick_Start.html | 2 +- ...asics.00___Understanding_This_Package.html | 2 +- ...e_Basics.01___The_SuperCamo_Singleton.html | 2 +- .../The_Basics.02___Document_Basics.html | 2 +- ..._Basics.03___Embedded_Document_Basics.html | 2 +- .../The_Basics.04___DB_Client_Basics.html | 2 +- documents/The_Basics.html | 2 +- documents/Tips___Tricks.html | 2 +- functions/Logging.SuperCamoLogger.html | 4 +- hierarchy.html | 2 +- index.html | 2 +- interfaces/Interfaces.BaseDocument.html | 8 +- interfaces/Interfaces.CollectionAccessor.html | 10 +- .../Interfaces.CollectionsListEntry.html | 6 +- interfaces/Interfaces.DocumentBaseData.html | 2 +- .../Interfaces.DocumentConstructorData.html | 4 +- interfaces/Interfaces.DocumentKeyRule.html | 32 +++--- interfaces/Interfaces.DocumentObjectData.html | 4 +- interfaces/Interfaces.NedbClientEntry.html | 12 +- .../Interfaces.findManyDocumentsOptions.html | 6 +- .../Interfaces.findManyObjectsOptions.html | 8 +- .../Interfaces.findOneObjectOptions.html | 4 +- interfaces/Interfaces.updateManyOptions.html | 8 +- interfaces/Interfaces.updateOptions.html | 6 +- .../Package_Exports.SuperCamoInterfaces.html | 10 -- modules/Classes.html | 4 +- modules/Error_Classes.html | 2 +- modules/Interfaces.html | 4 +- modules/Logging.html | 4 +- modules/Package_Exports.html | 20 +++- sitemap.xml | 108 +++++++++--------- 56 files changed, 284 insertions(+), 286 deletions(-) delete mode 100644 interfaces/Package_Exports.SuperCamoInterfaces.html diff --git a/assets/navigation.js b/assets/navigation.js index c952e49..1aa0aea 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WXXU/bMBSG/4qVSbsqI9AOdb1bC0xofI0WdoGQZZLTxiO1I9uZiib++5SkDflwYptegs/7vMfOOfbp4z9PwUZ5E+9HSkOQ3sALIhqHApg3eSwXf6U0eEFzRYTyBl5CVORNvJAH6RqYkof5Ms6Xv0RqHXsD74Wy0JuMh+PxiT9+G5SkRQRoSiQNpA60iAAXq1qOPjnfRwfonoUgpCIspGyFFhGV6JYEL2QFBh/fxxjX1DhT463atB//CB2gbFPzNAExI2uO5pStYlCcmZyPMMbZ36UUl1Kj7TE6QKdbqt2B+scY452k75SrNkN0gM7WzxCGELr6DTHGO62z8Sjb3xTNYmpvOMo2OMWFptfoqVqRNJHoM1oIGrzoLWgisy+VB5gS35YNOtskXKgKb83DNAZ5uA3A24A671hf4TMexxAoytn3IAApubDjftIKC6vR0bfR0B9VUn8PvqRSnTElXp1tqsoun2sIn6dEwq4kzoTgwvKkPnWK+9yKinBwKAV91F0KDtyKpI+865oPOGikXU7ltWOJr8YbmRdMgViSACoflpb/axlodI3O+Hry9lTr2ztYggAWQMebNYuJlKCpq+3C3p0XFJyS146tWxwdj227rRtdBvexm03SDW5GmqjNTtLxihgTyS4327y6O0ZHbUb30TVd0kSWIW1OtWDzqwp1lmW+jPcpzpzQTrMO1or6DuAUYlBwTmicCjDRa8F91FsulRO5JTDR5+SvC7sSbiI/kJiGJDtCB35L1OsiwO1wGvEGtsvR1KINXPeD0Wh6m9E+ccusnVN2yrcVfEXZFdlYNWqf1tFTSspWDyRO4ZyLW8ETEErz2hj9tZx9cinf8Owq3jehGswpq1L5m6qIp+qUKPJMpHstdIGcsrlnsEkgUBB++FO1EU4Z5Cd6zdUFm0Wc1mY4ywRahP6nUTct7t7FzolQ/yjq557K6FnhdU8+2bipm9XaU6CebJoFu/hSMwyaHGTHTFj32O0z3zNRxMRvxtuwZ5xJJdJAceFi0ZDZOP2E17s0BluHbbgN+eb5DwTKJf13RR9/SVl4RdjrTiVvkvzjmVy6dDZeRWauTnWVyeeGQSFwcGlq+jzef1FYtUUjvI+cJiFRkO/YLvWWwEx3IndSq1flJV+tKFu178ntgtUlWf5iyURQuc2WKSvulBLXCK3jT0b5j/Kn/8Bp50hHFgAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WYW0/bMBiG/4qVSbuC0ZYOddytBSY0GIzTLhCyTPLReqR2ZDsTaNp/n3JoyMHHclnle5/ni+PYqe//RgpeVHQYfctpAjLaieIVTRMBLDq8by7+zGn8jK4VESraiTKiVtFhlPA4XwNTcq+8jMvLn1ZqnUY70TNlSXQ425/NDkazfzsN6WYFaE4kjaUOdLMCXF3VcvTNjUZoF92yBIRUhCWULdHNikp0SeJnsgSHZzTCGHfSuEjjOu26n9EY7aLipq7zDMSCrDm6pmyZguLMZR5jjIvfTRQ3Uad2gnbRUU31G9DRBGO8idhGua3ZR7voeP0ISQJJqG8fY7zJBounxf3N0SKl/sJpcYNzXGWsoof2jKSZRB/RjaDxs15BM1k8qbLA1Xg9bdDxS8aFavHWPMlTkHt1Aa4LuryJfobPiYTNAPoRP/QiFX46/jLdH01b7S54mkKsKGdf4xik5MKTrw36W46IIlub6rDbdkalOmZKvAar2km3R24vkj6mzYMsH6r/yGliLsOCM6lEHqugR2ROu3zf4fUqTyHQ85Zy8S8ef0OstriVTtBkeaIsOSfsdROSF1n5TD1dlrjLWLW3pW8QttkuGFT14S5N1GT6Aclje8k6FoILX5cxbLNVu0SAoQm4qSFLwTBl4wfuAr2IjbzZqbcwaKImU/Op44lv15uYeZYQBeXEDpqiupzdsQ3fxH7ofIRcwRMIYDEYPsAXKZESNOb6gtdnhG2zjytOwxvWdhXjycx3yzWjm2Ibu/92m8H9She1vwToeFWNi+TXm29f5ldRR+1X2+ia16+PbEqGnPaELddYZJyW5WX8nslZEoZtdsHakG0AjiAFBSeEprkAF71TbKNecqmCyIOAi35N/oSwW+Uu8h1JaUKKIQzgD0JWi4CwwenVO9ghQ9OpdnDDB0aTsb6M/o17dh3cclC/g+Jzys7Ji9eLassGOqWkbHlH0hxOuLgUPAOhNLuN06/lvKeXZg8vluL3NtSBBXXVJH9RteJ5+R/mkcjwuWACBXVzy+Alg1hBsvWjGiKCOihH9AdXp2yx4jRu71aeDQwI9q3xlCkQTyTW7Ytv195x8EMbSJtn/vKZfD7wPPLRk13fgia+7ljEZZCGb8Kuw3wgouf3633YxqMQu6IX8zENDkHshrrch6w7/rDD3xI2vvvgQ28x5XxcpiMPu6mbcnnMhx1mSz9jcxiPCPT4XrmNbPkTrGcPAm56ENlIbS+VZ3y5pGw5XCfrC16LZPOPpQhBazV7ylm1pjS4XmkXf1D9KX/4D4EyqZ4UGwAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index 4fdc144..947ad4e 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81dXZPbNrL9K1Ny1X1SZtngt98SJ3sr924+dpPNfXClpmSJHnM9QykU5bXLlf++BZCggEaDbH7M+D5ZHqkbh42DRgOHBD9v6uO/z5uXrz9v3pfVYfMyC7MsCbLtpto9FpuXm79fyv37m1+aXd1stptL/bB5uTkc95fHomrOf1Hf3qlvb981jw+b7Wb/sDufi/Pm5Wbz59bn9dd3xc03u3O5PxNOf31X3LVfTvIZBDdf3fyzOhT1udlVh7K6v/n1XXm++Xm3f7+7L4YbCoK7uzvL+E4a33XGBJDt5rSri6qxr2YAHtx8dSN/+cvlVNSvdo/Hm1/K6v6haI7VCDa4u7uT/+8t73rLNYCJm69uvu0aZvVKIO7u7rSFv6smAwlvvrr57vFNcTgUh4mIwru7O236FNAiGaNvbl49lGxIkQzSN3etyXpQfi1P55v/uvm1LvfvSQjl6Sz5or4fHECi99mx/Oa7j6dj3Vy9Ph4Pl4fi/Jfu+7vu+2GvcdL77Qn7fdUU9dvdvrj6Lvs/Oe4Js+HAYfxXNBCIqIejefHqWJ2b+rJvjvW3u2a3BNILv08WVMrxGPyf3vyr2DerIbfcPRnob3bnYjXIhrPVASvfXTuLwCJHqwN9dXx4KPZNeay+3u+L8/lYL4JLuntC0Oe/lefmu6qpP60E23L4ZDz+3+LTPy4PxSo0vvpaHe6PxeFNO/MsD7Hra3W4f78U9aefTqobF2FFjtYAmsRxeJ3S7u6aT6dl3W9ivO39zYZ6a12zJ8Bvy+rwU1W0uX7tQHcXcetpZJ0r05EauMAfdtWntvHzU14i2cyzXqROIE9+mURDz3Khl9Nh1xRPdXXY+zNekuLOk16W3cJTXdp17fC34/19Wd07a4bu74NrhSRylwrSrriWMm8vVTu79w7RL4dXBhodhfxVZ4GRd38fRA4i4xRinW3v0v3pMHwN8dpwDNcL2F/XHFNbfGHbDrZO+PCRXP0zFUpntBaGx+OheJgMQlutheK0a95NBtEZrYXhsGt25+ZYT+8S03IJGnKUuIW/H1b/2+cbJ3aTMwfK9RqXjRQEZuJQGUXBHSsIxtTBQuIwuCFXGOS6GyPCP5zKChFE11b3dbFr/J1AtvWiNxq+dueK5jPTg2MCLQfAWGyo5fQ3EYe2mY1gcHk1AcPYSsrror0CgyOJgMhOohPxHIa2phghQQhaU7nf9WZ3Ln4cShw0HtLBWuj2/Sifgcwxno/KHNmnuvht91Aepg9v23I1NL/sPsxA0lmthuLb4qGYE5HebiUkx3Mzt3ts0/XwzOmgq9l6OOZ1kWm4DpYP8/rnw9p9c57eL+c1++Qwpz8O6/ZFc2x3myaiMMzWwvHz8XR52DXFYSYg134tZP/zy08/TobTGa2F4ZemNjdCuCh6s/lFHCql2836QSDtT556UYVamly0dhcyZwmFm2atnMbbHFzW4zZZy/nxNq9F0nBxbkfatFmKoL+7gN2+abG09aK7r+PbySgoyxlorHF+XzQTNvwwIp/1UlTtsvT76lB85HPEslmKoC4ejx8mIrBt1onBNbwTA2EZLsXSlgBXl998Gl0dWcPHZ74+rh8Gt4DGgf3A2gtiIKuPJ71E5cOxjZZiKKtzUTc/VXwApsU6rUv9ZmLznck642fK1ZsW67Q+6eotk6Xtd+I1awvSBOHarYSEUWMTOCZU1uMoLAl4EhJsuRaaTnefjOVqt5inx8sEduhfr3H9X1eHf7bK9UyaehysjW0GcUnzVXHNp7LXxer45pDb42AlbO2u0pQpgTBcFcukCYKynLMaQetr1uB7LolqVJ5qzoevyvNXZfWuqMumOPgueyWpaplMtVyiGpOnFoRjslS1UKZaTaIakacWhGSZVDVJploP5QTJii1XLUE3R7riyVYrohpVSMblqxXRMHQSjoy1GiKupMWUs9bENbXjKFlrTTzTu46Wt9bCxJK6GDLXWnhGJa8RuWstHAzpa1T2WgsLSwJjyF/r4ZkihU2RwdZDOCqJjcph62FhSGMMWWwBHlzCf4eUgUFo+MdPXdKT7S0p7Z2rXVbie/BNLPUHQE0s+Wk880v/AWSTlwAD2KYsBRw3S5cENK7ZS4OBkC1bItA4V1oq8FFPWDL4RsfipcMQ2jlLCE9oFy4lJqAcrUy9CGcXqBPQMepUL74F5SobIXfJ4QG5dOkxBefcjl6yFJmCb35XL1uacDGylig0wkVLFS6+0SULjW320oWLi7GE8cyDT9+nrCUNjW7R0oaPb8oSxwd0jaUOH/HokscHc/bSh4+NsQTyoVuwFBoqso0lUf9MpRdf/4upix/7VjYlrfirebuVF9efD1fIV/gzK3W6XW6BfrXWgH1rP/X1q2NVDY0nEszVaHooCAzfluf9HBiW3TpIhnM0jYJ3gzUTwX8XE4PQGsxoG60plDP5bNy05juLGe33TX9X18f6Rg9W/AC0+vZOe+I+Bv1zv3Aoj9Vfd+XDhXjw1HZNmQznFxv49G0MZvuszQwLC+nLE6mpYfqiMVotQLOj88+q+Hgq9k1x+Lk+noq6cW8AGIHseviiEfTAWSOmRKyYUf6hPJ/L6v633cOl+Ouxnhtqj5svGu8hTGsE3Rc6ZuSV3Y/H5vvq1btjuSc2O0euz3HwRaNNo1kjzm6gmBH+R/G2qItqX/xf2bw7XhrvfcYjl+bz80XjPQhqjbB7ozcvs/Tu5KJk4VC2fP1/yjEusCdINHYk2b1R/bD7qBqafo296ReOtY1jndBew+Kpb687pvwCl7J51grXC2BOiUtGwLsakFu37HWA8eNnXgHglufV/ubFevZY2OH4QrFYIRDjUfi529Pnj58vxQyi6ZljhhEVLRmxx4v182ceMW7b88aMfcl0ZKaE5YvFZJWAcKLxc6838cfPl2MK2fjMMcSJDn6yllPkkDbPGSU/gBmRoiNA7QASJ7Lr7b/BU9cNX8ZB72OHZhsu+cd3jR8bfPAcKD7U3PDpTB5L/3EA3ptZuHBGbmVZAM5zzwoXGPNspnFQJlF4h5YbPqeemDlOmmo8GLNOqhy094GxD+Cbhmb4FL5ZcKzjLaahGTzsYhYY9/jKaYjGD7HkwqIZPHyCPen7zDzPcmUWn6ccIzniYR0mY0QzuExCMntKp6KhV08YnvHPZ/QQ1TrjZSMECGS1lC135WFBwy9a89G+8V3ycICGX2dCuL8aPF9YUJtTI2Jc43AwBl4vQbjtfr00DL43Goy0+GLw5gi/sfdG7+KPS1kX3C6xoBi2a8HZuwfJTAC0Hz9NZjqkS1X+cZnVVb3lWlAOxdvd5WGs2CexXE3XAvNYzuqj1mw1ELuPs0Ds/GcfzYrE34rqfrSK88WjN14xKgsAGcZrASorfUvsTxWlhUyA53e1FtjT7tDe/KcknzkYHQ8rQvu6rnefliCzHKyWt5GIPiVp96br0b/Zz6R+a7gWEOcW8glYRk91ZcExy53rMRuc9RP69TMsnagW2asmfHHz19okDO5CmwmDOl1yAhrOQZPTQbkHTk6ANH725HRA/jMoJwDjH0fJAmgOKO77vQzHlMnSoXWqj/9i1czexl9YLkajQ163P0S8N4Qh/67R0jA9lI/lWOk80PILbc8KD3HNa/SeD9v0/hsESPVgP36m9SE2e85eJNue3o/OldOBGn19muHa+u3SkFxO8jzKyS2+6O1GI2Ff2tDlj7xqzfFp/P4Zw4BbnRwK8zIXENWDhs3QITAR5FEYsN5cO/TG6QWvqGWBcbfzmWgmv3h2AA55vtwgDmSxBgDv6RijQAjLNQChE+1HYfS/X9q4+2DcYNvmz9e4blNRVXsLvHezv/DaMkH9vt2U6lTul583H4r6LGfzlxtxG97mm+3mbVk8HM6bl6/1Ump/fOw6W9fem9+7n/1WSBlA/rj99V+CzfZ1sA3T2yhLt9B9+P337WvtRf1C/UE7u/5FeYDN9rXYhuFtkiXbcCvy2xDA8gCOB7A8iM32dbQV0W0g0m2sPyT6Q7oVcBvnlkvhuBSWy1CBUnbbTDvKt5Df5lm8haD7k+UzdHyGls9os30dboW4zfJ0CyCvVEhnYiuS2xBiy1nkOIssZ7FyBtltKuOuoUKosUJEQYwdr7HlNbG89qGEPpaQUm4Tx21iuU0329eQ9Rec608i6D5Z3lLHW2p5yzbb16kmjCA5lzkuMstFLrtXbGNxG6SRZZk7lrnNVkleEW6j5DbNQ5umLtMBUV1xPSKNCZLbLAfJUBGTxi6dweYzKEInpLHLW7CJC5J6It1GwW0KiW3s8hRsooJkmMjIll06gs1HkDwSOWnskg5s1oGkTRiQxi7HwCYZSMKEQFEEXHaBTS+QnAnFNsxukwjlMpdgYDNMSM6EJMOEyzBhM0xIzoQkw4TLMIHyqORMSDJMEAnTZpiQnAlJhgmXYcJmmFC5MSWNXYYJm2FC5cKM6irhMkzYDBMq5eWkscswYTNMSM5EJMOEyzBhM0xk3lElXIYJm2FCciYClYxTO/cJl2HCZlgoOROJbZjc5mBfc+gyLLQZFkrORCEFO3QZFtoMC9VUHZHGLsNCNCdLzkQkPUNi7rUZFkrORCQ9Q5dhoc2wMPZGO3QZFtoMCxN/tF2GhTbDwtQfbZdhoc2wUHImSiluhy7DQpthoWJYto3C2xDDdhkW2gyLAm/AIpdhkc2wSDEsp1qOXIZFNsMi4U29kcuwyGZYJDkTB1S0I5dhESrvJGdiII2Jas5mWCQ5EwvS2GVYZDMskpyJQzJgLsMim2GR5EwckcYuwyKbYZHkTByTxi7DIpthkeRMnJDGLsMim2Gx5EycUsaxy7DYZlgsOROT3I5dhsU2w2LJmTinuip2GRbbDIslZ5KAbNllWGwzLJacSYA0dhkWowWD5EwiSGNiWWAzLJacSUiGxS7DYpthseRMQjIsdhkW2wyLJWcSkmGxy7DYZlgsOZOQST92GRbbDEv8OSxxGZbYDEvAm/QTl2GJzbDEP0smLsMSm2GJYhhZSiUuwxKbYYliGFmsJy7DEpthiWIYWawnLsMStPKUnEkDaq5KiOWlzbBEciYli/XEZVhiMyxR60lyMZi4DEtshiWSM2lIGrsMS2yGpZIzaUQZpy7DUpthqeRMGpPGLsNSm2Gp5EyakMYuw1KbYankTEqWFanLsNRmWCo5k5LFeuoyLLUZlkrOpGSxnroMS22GpZIzGcmw1GVYinYwJGcykmEpsV9hMyyVnMlIhqUuw1KbYankTEYyLHUZltoMyyRnMpJhmcuwzGZYJjmTkQzLXIZlNsMyyZmMZFjmMiyzGZZJzmQkwzKXYZnNsExyJiMZlrkMy2yGZZIzGcmwzGVYZjMsk5zJSYZlLsMym2GZ5ExOMixzGZahLTHJmVxQqTcj9sJshmX+Sj9zGZbZDMv9s2TuMiy3GZb7K/3cZVhuMyz3V/q5y7DcZljur/Rzl2G5zbDcX+nnLsNym2G5v9LPXYblNsNyf6WfuwzLbYbl/ko/dxmW2wzL/ZV+7jIsR9ut/ko/JzZc8Y6rv9Rvv7PNjb919v5qv/0O26N918Bf8LffYXu09Rr4a/72O2yPdl8Df9nffoft0QZs4K/82++wPdqDDfzFf/sdtkfbsIG//m+/w/ZoJzbwLwHa77A92owNJJ9yz5Y9sR0bIP6pTXw6PwK15+9s+oM3RQK57Y/4p7by6SwJ1M4/3vpXu/me3Whq8x/v/qsNfTpXArX/jwUAtadPp0ugJACsAahtfTpjAqUCYBlA7ezTSRMoIQArAWpzn86bQGkBWAxQ+/t06gRKDkB6AKgtfjp7AqEIAJIEQO3ye/InIQoAUgVAbfR78iehCwASBkDt9XvyJyENANIGQG33e/InoQ4AkgdA7fh78ichEABSCEBt+nvyJ6ERABIJQO37e/InIRMA0glAbf178iehFACSCkDt/nvyJyEWAFILQAkAdPoh5AJAegEoCSAn1yBAKAaAJAMI/XUeEKIBINUAlBCQk8sYIHQDQMIBKC0gJ1cyQEgHgLQDUHJATi5mgFAPAMkHoBSBnFzPACEgAFIQQIkCObmkAUJDACQiQKsiBFpwhyCgFHcgFAVAkgIolQACWlUlVAVAsgIM6ApACAuAlAVQYgEE5FIcCHEBkLoASjDwASDIiAQGUJoBBORyHgiNAZDIAEo38AGgxHjERiUdQEAPR0JqAKQ1gJIPfAAIOiK5AZSCAAE9HgnFAZDkAEpF8AEgSIhUB4haEtIDmhAeACkPEA+QkNAeAIkPELckpDMCoT8AEiAgHiAhIUEA0iAgbklIpxRChgCkQ0A8QEJCiQAkRUDckpDOSYQaAUiOgHiAhIQgAUiRACUyAJBbNUCIEoBUCYgHSEjoEoCECVBaAwCdCQltApA4AQPqBBDyBCB9ApTkAEBnQkKiAKRRQDJAQkKlACRTgFIeAOhMSCgVgKQKSAZISIgVgNQKUAIEAJ0JCcECkGIByQAJCc0CkGgBSUtCOhMSugUg4QKSARIS0gUg7QKSloR0JiTkC0D6BaQDJCQUDEASBqQtCelMSKgYgGQMUMqE57Y2QsgApGRA6t8GBELLACRmQOrfCQRCzgCkZ0Dq3wwEQtEAJGmAUik8d+YRogYgVQOUUEHLlEDoGoCEDVBaBX17ChDSBiBtA5RcQSudQKgbgOQNUIoFfUsQEAIHIIUDlGjhuTmR0DgAiRygdAtP/AiZA5DOAUq68MSPUDoASR2g1AvPPaGE2AFI7QAlYHjuZiX0DkCCBygNA8ATQIKASPQApWN47oglZA9AugcoKcMLgLpREzFQyRmeO0wJ9QOQ/AFK0QCgSxlCAQEkgYBSNUDQpQihggCSQUApGyDoUoJQQgBJIaDUDaBvhwZCDQEkh4BSOEDQUzmhiACSRECpHCDoqZhQRQDJIqCUDhD0VEooI4CkEVBqBwh6KiTUEUDyCCjFAwQ9lREKCSCJBJTqIY+/JB1Qdw3j24YVEwV9Kyuhkwikkwile0BIMlEQQolAQolQwgfQN00LQikRSCkRSvmAkGSiIKQSgaQSoaQPeqtREFKJQFKJUNIHfcu4IKQSgaQSEfjv9RSEVCKQVCKU9EHPh4KQSgSSSkQrldD3URNSiUBSiVDSB33/jyCkEoGkEqGkD/oWIEFIJQJJJUJJH5573wmpRCCpREDLQI8DgoFIKxGtVuK5f54gINJKhNI+ICQ3awUhlggklgglfnivgKAgUkuEUj88N/ETaolAaolQ6of3CggOIrlEtE9O0A8CEHKJQHKJUPIH+K6AICF+fqJ9gIIeBNQTFPgRCgEDAKinKJzHKMRACMknKRALlQLieTSAepgCP00h/De7C+p5CvxAhVJA6NtJBPVIBX6mQikgtOIqqKcq8GMVrWLiwU9QED9ZoRQQUrEQ1KMV+NkK0TKQLAYE9XhF9zf1mOWHom6Kw/ft45avX28228+bu+7pS8j146CfN+nm5ec//7w+bPny85/G85byO9mGnKOv9tHVXPDMwTTPruYhz1xY6OFqH/HsQ8s+vNrHPPvIso+v9gnLXr/w8eojFFcfkLdmkWj/zbt/pQDefgh5UVanR5pxMgItVzytsyxjOZPHRvd/NLyKxHCqAaY8gG9253J/tuJgOOui0P4Tt//w4tsfsGV2ssESWeCx/HSPMZtUDww3qe4PXgj33ePiBqp0KnVaH/3LMa+u8tjsB944ap3ptxAbvlLTF29MdL6MF3ca/iyO8MZo6+++sB2ZDA6nROxBvc3S8JSbnnhJr39PrOEmMt0Az41xZqdBBQFmCmAStHe1U0dVFO3BgOaYN0Of5LO82i6FSY5udIpMD/wuq8ipf1pTsoOK9nQLY7QZ6EPdlmASqHetPBheYyPZRl1iyWOdZHVeTJm8N08mu7aRmCO7S4tyWTPRJRkVYY4CjTvjks942YMRaDM7dvNP2LmOgi73dv/mgQ5Vl6JB/wL0lCXl3e6DDmekKRLrH8f6x7H+cax/HOsf6zalTNN90D9O9I+TnnwBMwQXOwtnRurkhrEudnbOjMwqpotglutIMZEpr3R+SI2pkTuOlbvW3vRk9HXCzHzK0+OusniYGXNhykzGytGxskKXmuUnb9S1b9cwhrQBJeqGW66rEZ2lpEzCdd6d6G/0r0GSUHvOeP16eGPl5GTqpN8fZWxOF2aplPNSojvTJwYX+mEY6A+C2RnK7ZW2bz515+wbXWxEL+UNMdcrzuOpMfkyx37r9K1+q5E5UZozecK8cKIeBnNy2VxrV7YzVWgjeguzuNOZMGN2evcHI/M77k0u6YybTYP9vvhUqyPlDbdmjdUvN3i5S//hqE7scwCbnaVnoYyXy/Qf7OnayN56hpG7iCyH9VGeSta96tWgpzHOmQsifXSnRSjjWnldor3QV2p0StLN8II5P7nlZRCY9S+vvCm645/M/jTSEM+JPKpwVx3a8Ywnptx0x2OF5Q/NT7lxkRkvY3fu2uPqJDyyLzKDdczR7DhuB4jt1uhi5ii23B4rcqWfGXzOeHzGbluwllOjTs5407N06g+pkcpS3vh1/B1PTjkfGglYCD1q+Fzw9ZQxtpm1BPJGYTW340Bj5cfW1/3GoEr5g4rudWOSTPkDvvdFXbXR8SLQV80rNe6LZnjNmxoZIOH1elnJAzZxZkqNEZ/yRnzrCJfMxrBhVrXXAzntusdczjNLs+sbCY7VY1k97j66M4O1SM15I7E7BtTctbO4rCdm6DbehOCloYfj/X1Z3Vt0MeAxy9zurHwTnTA5x+sG9SIOM05maZfzuPW4+/jQvbDC9GT2ZM4bVerdJKYPs7DKmXEpKwqNufGU8/KFs2yIjEEddqks1LuuqV73M+cNvHyIjN4Lu4wRdmVqoovKVLeW6awf8PqoKg5vfHvmkdFTzKIJuyu6ozZNNibmHMUbcdKtuy2dGJ7iXI81Xh9ePTr7VqFZLOohHPBIJt1SocyNTswyDZXvE9fKlm9rWdTHgdf/p/awUytpI5lsy6x1T7vDTr7C5EP7ChOzy001IuAl79PucFavanHdmQs2eRsOz5083VWvf5ytVlOb69J3rrcX+r1L5kzYvpLCGEZGsgq7iPb7hKnur4DH29PxTCghsTFNxDonBPoDc/q5uiY3HswJgLkfJz2edx9sqAa9+j3WQH8QTHJ0jkmgpkaZ8P1d3+tigDUyTNT1VK53SwWTeVff5bGiEAfmBkTMSwqnuiBoYPSR3sjO9fQDvFTbOyZja6aahDefnerC4YAxIqIuw+Z6BgNmtmndkijNBB4zqVoXJAGMC9YaQa73iGCqa1//m5JayO2m64slzExrLi+gXwHyOPXHpag/UWsWEx+vd/64lPv3pg+jS3jDpi4ejx8IVcAY3QkPy/VtiOYcYnIk52UJuXFoq+zGwI26bJvrrAu8rIvHRmIAi/UGfqA/MEVF78gwezLmMe1cVvcPRYOIZqDkpYFzs6vtRdNURpzlcfJ7dZy8UfwgHPI2B72sFjx+9H7ppacwGMeMmHYoF3SFtd4MzdKFV6E17+zdaufWE178m3elvcE69WaopjzZhby5R8DzcPzX2aZRYm4a6wkg0B+Y/dcc3Z2bxAhTrOu3QH/gRv54Op4uD7umOBAtmLdj6Rkh0B+Yq5Dm2Na4lmNjEu8F5kB/YC6Ymrrcv7dpHEzuLnTzF5j330HOG7SX6lDU52ZXHdBlxlP5p1/aaiZx63Y03jgwtqSJmc5c+/Q3cjCvtN09JpyaQ03fY8GcR/X7b8wp3owc9Ms93hRG1jhGt/Y3OwT6Q4844E09I6WO2WPRJMxXj769vMC64YRHB8L5+axXnW+P9ak+noq6+WQ3ZG4/Rbziaqyhunhb1EW1V2t8uzVzwyyeGbPe/b/L5t3x0lBKoHyq37guXqZxWrpUxcdTsW+KAx07cwkRzewkFbTq2JQVdQ9lYC5VI0ay+327OZWn4qGsis3L17//+ed/AG6of3sJ6AAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81dXZPbtpL9K1Ny1T7JEzb47bfEyd3K7s3HXifZB5drSpboMeMZUqEoX7tc/u9bBAkSaDSoBsXY+yR7xG4eNg4ajT4U+WnT1P8+bZ69/LR5V1aHzbMszLIkyLabavdYbJ5t/udc7t/dvGh3TbvZbs7Nw+bZ5lDvz49F1Z6+kd/eyW9v37aPD5vtZv+wO52K0+bZZvN56/L629vi5rvdqdyfCKe/vS3u+i+9fAbBzdOb36tD0ZzaXXUoq/ub396Wp5tfd/t3u/ti/kRBcHd3ZxjfdcZ3gzEBZLs57pqias2rmYEHN09vuiNfnI9F83z3WN+8KKv7h6KtqwvY4O7urvv/aHk3Wq4BTNw8vfl+ODFrVAJxd3enLNxD5Q0kvHl688Pj6+JwKA6eiMK7uztl+ndAi7oYfXfz/KFkQ4q6IH1315usB+W38ni6+Y+b35py/46EUB5PHV/k97MTSIw+B5bf/PDhWDft5PWxPpwfitM3w/d3w/dMr/+s7+/L6t7yNvx91ksSjW5G1nd2RTO6e3Ou9m1ZV5NDdOR8sBU6CvnzwQIjH/4+ixzENFbP64eHQoL8dr8vTqd6Qj/Yji7tQ+fhK4jTiWOYLmBfV6e2Oe9b/zM+MW1nz0740CMRiGkU5YcvlMFoLQyP9aF48AahrNZCcdy1b71BDEZrYTjs2t2prRv/IdEtr0FDzpJ/lqf2h6ptPjJgjcd+uXlinnLhRJmu8bqZgsB4TpWLKLhzBcHwnSwkDo0bPxeH19/tToVa0p2I8IG+rBBBNJ113xS71j0I5LmejEbz125d0XJmOnB40HIGjMGGplv+PHEom8UIkjgOkxHC3V378eg7JhLD7WjqB+W2vwKNI4mAyEyinngGk8UhQQh60+937e717lT8PJc4aDykg7XQ7cdZvgCZZbwclT6zj03xx+6hPPhPb9NyNTQvdu8XIBmsVkPxffFQLInIaLcSkvrULh0e03Q9PEsGaDJbD8eyIdIN18Hyftn4vF97bE7+43Jac0wOS8bjsO5YtPUvr/8s9p5V0RPNbC0cv9bH88OuLQ4LAdn2ayH7rxe//OwNZzBaC8OLttEbIVwUo9nyIg6V0n0zahZIf8jfvalCZ/IuWocLWbKFwqdm7Zwun3N2W4/PydrOXz7nVCTNF+dmpHWbaxGMfUf2+XWLa89eDB3f771RUJYL0Bjz/L5oPRp+GJHL+lpU/bb0x+pQfOBzxLC5FkFTPNbvPRGYNuvEYAqvZyAMw2ux9CXA5PK7jxd3R8b0cZmvj+un2RbQZWA/sXpBDGRNfVRbVD4c0+haDGV1Kpr2l4oPQLdY5+w/7Sp3Y5Q+/WCyzvzxuXrdYp2ze129YXLt+d+U1eGXiteC1EHYdishYdTYBA6Pyvoyii60/qsuZbkWmv7y/LFMdlfztD57sEMdvcb1f1sdfj8e+gm3iKYOB2tjW0Bc0nxVXMup7HSxOr4l5HY4WAlb31XyWRIIw1WxeC0QlOWS3QjaX7Mm35eSqC7KU+3p8LQ8PS2rt0VTtsXBddkrSVXXyVTXS1SX5KkrwuEtVV0pU60mUV2Qp64IyXVSlZdMtR5KD8mKLVddg26JdMWTrVZEdVEhuSxfrYiGoZNwZKzVEHElLaactSYu34GjZK018fgPHS1vrYWJJXUxZK618FyUvC7IXWvhYEhfF2WvtbCwJDCG/LUeHh8pzEcGWw/hRUnsohy2HhaGNMaQxa7Ag0v4H5AyMAsNH/x3l/Tk+a4p7a2rva7Ed+DzLPVnQHmW/DSe5aX/DDLvLcAMNp+tgOXm2i0BjWvx1mAmZNdtEWicK20V+Kg9tgyu2XH11mEO7ZIthCO0V24lPFBerEydCBcXqB7oGHWqE98V5SobIXfL4QB57dbDB+fSgb5mK+KDb/lQX7c14WJkbVFohFdtVbj4Lm5ZaGyLty5cXIwtjGMd/PvHlLWlodFdtbXh4/PZ4riArrHV4SO+uOVxwVy89eFjY2yBXOiu2ArNFdnalmj8TaUT33iE7+bHvJVNSivuat48y5Pp8PkKeYK/sFKnz8st0CdrBdi195NfP6+ram4+kWAmI/9QEBi+L0/7JTAMu3WQzOdoGgXvBmsmgv8sPIPQGyw4N9pTSGfdb+P8Tj9YLDj/eOofmqZubtRkxT+Alt/eKU/cn0H/Om4cyrr6x658OBM/PDVdUybz+cUE7t/GYJ6f1cwwsJC+HJHyDdNXjdFqAVocnd+r4sOx2LfF4demPhZNa98AcAGy7eGrRtABZ42YErFiRvmn8nQqq/s/dg/n4h91szTUDjdfNd5zmNYIuit0zMhLu5/r9sfq+du63BPNzgvXZzn4qtGm0awRZztQzAj/q3hTNEW1L/63bN/W59Z5n/GFS3P5+arxngW1Rtid0VuWWUZ33abkyqls+Pr/lGNsYH9DojEjyR6N6qfdB3ki/2scTb9yrE0c64R2Coujvp06pvwCl7L5ohWuE8CSEpeMgHM30LVu2fsA7eAvvAPAZ15W++sX6+ixsMPxlWKxQiAuR+HXoafPnz9fixnEqRfOGUZUlGTEni/G4V94xtjnXjZnzEumI+MTlq8Wk1UCwonGr6PexJ8/X48p5MkXziFOdPAvazlFDmnzJaPkBrAgUnQEqA7gj1VbNG92e6L9N3012/sT8dReJx/eVY5+dJf8x3dpEF2/S9fvcmGebv7pTA5L9+MAnDezcOFcuJXlCnCOe1a4wJjPZroMSifKzE/naVy+T8y8TJrqcjAWPaly1t4FxnwAnx+a+afwLYJjPN7CD83swy4WgbEfX+mH6PJDLLmwaAaf7AdZXgJ4Yj7PcmUWn3weI3nBwzpMxogWcJmEpI+USkUyLV1eKfDhC0aIOvvzaRH3AIGsrmXLXXm44sRPevOLY+O65PkA9XeGeMRmMvhyYUHn9I2Ido3zwfjv4uO/zg+XZjY6+towGLdG8M/4ZPbmCLex80bv4q9z2RTcITGgaLZrwdnbD5LxALS//DQZf0jnqvzrvGioRsu1oByKN7vzw6Vin8Qyma4F5rFcNEa92Wogdh8Wgdi5n320KBL/LKr7i1WcKx6j8YpRuQKQZrwWoLJSt8T+UlFaiAc8t6u1wB53h/7mPyn5LMFoeVgR2rdNs/t4DTLDwWp5G4noPkl7NF2P/u1+IfV7w7WAWLeQe2C5+FRXFhy93Jkes8HZP6Gjv8DWiToje9eEL275XpuEwd1oM2FQT5f0QMN50KQ/KPuBkx6QLj970h+Q+xmUHsD4j6NkAdQnlPH0r1+OnOGkTK6dWsem/pNVMztP/sRwcTE65HW7Q6Q9JIkfJNvo2jA9lI/lpdJ55sxPlD0rPMQ1rzF6Lmz+4zcLkBrBcf74jSE2+5KjSJ7bfxytK6cDde6fpcaKjnHstSE5H7vnUXqf8clodzES5qXNXb6klUcItOO/YBjwWb1DoV/mFUR1oGEzdA5MBHkUBhOeGRFo7l10TzyenIzfdccBY7fzmWh0w2vhkM+Xm8WBLNYA4Hw6xkUghOUagNAT7S/CGI+/9uT2D+Nmz60fvsZ164qq7C3w3tr4xGl7LahLqsYsKrfxWrAILYGFyLBbC4ylO7GgaFbXAiHvypgFgSzWy60qYfPj4bRdDxQh4DIhndZM+S7th0WXyWi9POsREtvoWhizO9lZLA7LNQDN7BsvQiJt1wLl3AqxYBHW1wKjtx6zaLDJOhCo8p8BwzRjQnm13ZTyJRbPPm3eF82p2/w+24jb8DbfbDdvyuLh0L19XXUe9/XjkGBVq2rzajjsj6JbFbuD+6O/CTbbl8E2TG8jEFsY/vHq1fal8iKPkH9Qzqa/SA+w2b4U2zC87d4vHW5FfitCMDyA5QEMD2KzfRltRXibZ+E2Vv9I1D/SrYDbOIoMn8LyKQyfoUTVG24z5SrfQn6bh9kWguFPhtPQchoaTqPN9mW4FeI2C9MtgLxWkW9BbEVyK+LUcBZZziLDWSydQXabdnhGrBAqsBBRGGPLbWy4TQy3YzRhDCeklNvEcpsYbtPN9iVk4xXn6l8iGP5leEstb6nhLdtsX6aKM4KkXWa5yAwXeTfAYhvDbZ4YhrllmJt87egrQsISbKoD4roke7SNktskNYcbCJabNIeOoSLeRuEt5MjYpjOYfAZJ6H4QYzNSYNMWTN5CxzyRbsPkNs3NeQQ2TcHkKXT8Etk2Cm5jDNsmI5hshI5FIieNbcqByTnoSBMGZLRthoFJMejoEgJpbHMLTHJB7o62zS8wCSYCZ7SFzTBhMkyAM9rCZphAibTjTEhNCkHkS5NgoqNMGFLsFDbBhEkwETnjJWyCCZNgQmbCiDyzTTBhEkzIfBeT8bIJJkyCCUmwhDS2CSZMgglJsJQ0tgkmTIKJjjIhPcw2wYRJsLCjTJhTAQttgoUmwcKOMlFAGtsEC02ChXKpBtLYZliIluSOM5EgjYmV12RY2HEmIukZ2gwLTYaFHWcikmGhzbDQZFjYcSYiGRbaDAtNhoUdZ6KEPLPNsNBkWNhxJkpJY5thocmwsONMlJHGNsNCk2FRx5mIZFhkMywyGRZ1nIlJhkU2wyKTYVHHmZhkWGQzLDIZFnWciQWV8yObYREq7tw5LCJqOZNhUezM+ZHNsMhkWOReJCObYZHJsKjjTByS12wzLDIZFnWcicl6JrIZFpkMizrOxDFpbDMsMhkWd5yJE2Kpim2CxSbBYkmwlLK1+RWb/IolvzLK1qZXbNIrlvTKKVubXbHJrrjjSxJQtja5YrRT6OiSAGVL7AZMbsUdWxKqJIhtasUmteKOLAlVKcc2s2KTWXHHlSSibG1ixSax4o4qSUzZ2ryKTV4lHVUSileJzavE5FXSUSWheJXYvEpMXiUdVRKKV4nNq8TkVdJRJaF4ldi8SkxeJR1VUopXic2rxORV0lElpXiV2LxK0Dazo0pK8SohtpImr5KOKinFq8TmVWLyKpFbR4pXic2rxORV0lElpXiV2LxKTF6lHVVSilepzavU5FXaUSWleJXavEpNXqUdVdKMSrKpTazUJFbqrulTm1mpyazUvR6mNrVSk1qpu6ZPbW6lJrdSd02f2uRKUaPCXdOnRFvCZFfqrulTm16pSa/UXdOnNr9Sk1+Zu6bPbIJlJsEyd02f2QzLTIZl7po+sxmWmQzL3DV9ZjMsMxmWuWv6zGZYZjIsc9f0mc2wzGRY5q7pM5thmcmwzF3TZzbDMtT5ctf0GdHyMhmWuWv6zGZYZjIsd9f0uc2w3GRY7q7pc5thucmw3F3T5zbDcpNheceZNKcSYG4zLDcZlkfOBJjbDMtNhuWxMwHmNsNyk2F54kyAuc2w3GRYnjoTYG4zLDcZlmfOBJjbDMtRVzV3JsCcaKzizmrgzID9d6a59rfBHpxJsP8O26MGayCcebD/DtujHmsQOlNh/x22R23WIHJmw/47bI86rUHsTIj9d9geNVuDxJkT+++wPeq3BqkzLfbfYXvUcg0yZ2bsv8P2qOsa5M7k2H+H7RH/ZLeezo9ANfet7j44UySQ/X3EP9mzp7MkUC1+3OOXbXs6UQLV5cdtftm5d8An6Icb/bJ3n1F7CaA6/bjVD+6yDahmP+72ywZ+Rm1HgGr3436/bOFn1I4EqIY/7vjLJn5GykJUyx/1/EG28TNqXwJE0x9Q1x9kIz+jtiZAtP0B9f1B9vJFpBS1LKEUNSBEAEAqAMjGfkbtVYCQAQDpADAjBAChBACSAkB29zNqGw2EFgBIDADZ33ednqAg0gNAtvgzaicOhCAASBEA2eR3nZ7gIBIFQPb5c3ICEqoAIFkAZKffpRESJETKAMhmf05OQEIaAKQNgGz3u05PUA/JAyA7/jk5gQl9AJBAAOEM9QiJAJBGALLtn5MJgBAJAKkEEM5Qj9AJAAkFIHv/OZlACKUAkFQA4Qz1CLEAkFoAUgDIyQREyAWA9AKIZqhHKAaAJAOQKkBOtVeA0AwAiQYQzVCPkA0A6QYgpYCczHqEcABIOYAZ6QAI7QCQeABSD8jJrEeoB4DkA4hmqEcICIAUBJCiQE5mPUJCAKQhQDRDPUJFACQjgFQGICDTHiEkAFISIJ7hHiEmAFITQCoEEJB5jxAUACkKEM+QjxAVAKkKIJUCCMjERwgLgJQFiGfYR4gLgNQFkIoBBGTmIwQGQAoDSNUAAvquGEJlACQzQOxu2QGhNACSGiB2d+2AUBsAyQ0Quxt3QCgOgCQHkDKC48YeQnUAJDuAlBIct+cQygMg6QGknOC4Q4dQHwDJDyAlBddNOgQBkQQBUlZw3KdDqBCAZAhIegKSSiIQUgQgLQKkvuAKIHWbESKg1BhcASQIiDQJkDoDBAl9AQQDkTABSZ8CU9oBQUGkToBUHCAgdQIgFApAEgWkfRIk+2xAyBSAdAqQ0oMTAcFCpFWAlB8AHLd7ETREegVICQKAzOOEYgFIsgCpQgCQeZgQLQCpFiCFCAAyjxK6BSDhAqQWAUCWgIR0AUi7AClHAJA1HKFeAJIvQCoSAGQRRggYgBQMkKIEAFlFERoGIBEDpC4BQJZBhIwBSMcAKU0AkHUMoWQAkjJAqhMgyDqEEDMAqRkgBQoQJP8IPQOQoAFSowDynlYgJA1AmgZImQLoO1sJVQOQrAFSqQBB8o8QNgApG9BLG3T/h9A2AIkbIPUKEPQyQOgbgAQOyN03XgIhcQDSOEDKFo51kFA5AMkc0Osc5K04QAgdgJQOkOIFfTcOEFoHILEDpH5B35ADhNwBSO+AvCcgvYwRkgcgzQPynoH0MkbIHoB0D8h7CtKLCCF9ANI+QMoZIOgeKCF/ANI/IM/nLoG69xff/CuzIF0NCUIEEUgEEVLUcFyCIFQQgVQQIVUNoG99FoQMIpAMIqSsASF5H50gdBCBdBAhdQ0IyZkgCCFEICFESGHDiYC4KRgpISJI5oJI3BiMpBAhpQ26pheEFCKQFCIC9+3ngpBCBJJChJQ26Ps+BCGFCCSFCClt0LKpIKQQgaQQIaUN+lZKQUghAkkhQkobdPgJJUQgJURAT0FqLRKEEiKQEiKktOEoqAWhhQikhQiI3fWwINQQgdQQAYl7TyAIOUQgOURIfcOxrRaEICKQICKkwgEhVQ8KQhERSBERkLu3ZYLQRAT+HYQI3BW9oH4KgX8LIcBdEQjq5xDW7yGEe0UT5G8iEA9F6F6QBPW7CPzDCBHNLAfUbyPwjyNEPJPNqd9H4B9ISI3DlYyp30gMf5M/OnxfNG1x+LH/8eHLl5vN9tPmbvgtIuTqJ5GfNunm2afPn6efHj779Fn79WH3XXeObqmb7KPJXPDMQTfPJvOQZy4M9DDZRzz70LAPJ/uYZx8Z9vFkn7Ds1duCJx+h5kMkvVk6fOZp/9nJrCzv3ROHNXiBFt+uW9A7S3kj1b1qYPyj4VUb9K4PKM27zMX0Wu5PRgA0b71R1H/E/Qfv0sfHMmpAhe46Y/oZfs2r+RH69Q4QO82V567E4Ut9OdP7GF+prM0e0IHx4t87U++u13zpsYLcx5f2umfNn9D9ZR7+7gvTkR59EXg4epDvQNY8xbon8PBk0CEL9CvjpQ39Sc96+tKDnjLZMLrayWdeFP3jZPX5qYc+5uVV7NV0KYzIDTMgGfJJVzYvO0X/lhU9Heu5kEua0W033kX/hAktu+hzJFOIfV1LD7pXLbGKfEjaw2d3R1z/j5g5jfTHY07niDVyRGohyJlpZ3JJRqWrCKewJLHK4VzA2juHNJYkms9QAR5cDzk9Gj7T4TOPVT6N1D8S9Y9htLpbHIZ/KOqF6uBQHRyqgyN1cKQOVqfsJNPhH+rgeBwpdXDMKyP29dnM6qlGs4SZE5piZ+bgUBtxMQQwHT5zJjDplE43sVbrcdOCdNfb6560NSxmJlLp6XFXGTxMNMokzNwuHdWVEblEozNz1uHkE2pQxDDd0uEzHwnDS3XaW2W0E+jrhprPCW9YD6+N2Zv4lhDj4/T1xUdPASkvI9p1Q6RRQU3CTIUrYA6F9DqR9vXH4VUv2gBr8yvmzS/bK87iiTYizInfO32jXqynZ1R9eCPmhVPltbZ664Uw25ms2/HKGui5OVHrIHNbof6g5X37BKl+ApX1gRnV4Q/vio+NfFCVTlNj2gzZUDALQfWHWj5byQad675BgfaLt7loa9XquMzkvGR7aOru8ULDW8c1mmqMiHkjpp4ibVytBo13hcoLfaVa+ohU6cNcpayaNdPpydxaFcOTlfQKRMsSvITWPeVqVx36aY1Xp1TjdMpb5gx/aJFKtYtMefwd3PWPnergkUORaiObeF335LifIaZbvbvBS2iG27oi+wepRueER2fstgdrONVKp4S3SHdOnSFNtMyQ8Kav5a8+WjU96EWAUBsFIXjTRp2BGivNL7OmQN4otELvH6lmlBD8eDgokOg9EP7EIkc+0TAmvMxh+CKvW09HaosimHnpvmjnd9Ox5j3m5YGy6h74bFXPekbnzfveEa6e9TYob/JMD4g2F1S9ocGs06Y35NTVY1k97j7YLQ2hFwEZj3/DY6l1L/pyn4/NALXuB7xk9FDf35fVvbHuaCmNlyiHV7fo4PQ+V8YbBfleKL1W0ouwjEetx92Hh+H9SbonPVQZj/jyVVm6D30Wpcy4lBWFRs9DGS9hWFsII5mNHY+hcEnGrhYv8ngrIfTIR4pQ/WekehzJeDbVich5Y1QVh9eudnyocY+ZobC7Ynjys75O6cIO8CZc59bud8f6fkaV78Abw8mj3cEyepKZ2nAw27qdY7I20TiSCjWMPOp2PnHFbPjWplQ+BoJHgGP/NFHDHVLetsyK97g77LpXar3vX6mlR1TvG2e85H3cHU7y1WGEO6PzyqtJ+senqk2Q1XXVr3lI3+nwmastCHMh7N+QpE1gPeEN03NsGCZjN5NHr2N9IiSWSJtT4ZATMpUbmIvP5JnsQeghZzbmOo+n3XsTqbaMq15rptqoAZMZg18CZ65n4ojvbnrHmAZVI204DFOmhitgsm7yXdYVBVjPNSEvHRybgqCANkCqm52ppSfgpdnRMQVUZ3HEW8qOTWGNv1ZuhcOilanFK+AtMoNbCqReF0RMljYFNfqhdr1KJshUUz/wdU0PfqYv7cy9j/6CIz0l6q7ysQjgEeqvc7l/p7vTBom3ijTFY/2e6OZr0zHmDe70Kl29StPXj5Q3rbt2n3k3gF54DMkxHT5zXo602KzxLRw2sZlqwDOlQBeVjbKPx41TWd0/FC2ihj7jeG7aXWNub3zpcOpeRLKXLyLRrgjh6G4+UfUs8Mgx+u12SoUpEer7Qx7K9q1ZaFt3i/DC1b4tzQaP741LbXk0S2S9VOR5qP88IUVOG/VouJxc5VlmtNva7olE+n1VQ2GkSmTgxr0+1sfzw64tDsQJNJooxTVXeZdZ3Ld1XzkaAdFv6BrWxVytj8xtSNuU+3dmWzjwHip0kxbod5pByisrztWhaE7trjrgq/Tlnnoztw5IbxekvKvSur1Ua1JXnwM15wUv5w6tWcot6G7Vnkrwlgf1ojPdn77fDdQ+ilmUkhWkNhzqfoJMrc2BWicy3joxX0nodS8zApZDR4ss1/kQ8vhA+D6d1F7uTd0cm/pYNK2x7871TpzgVS6XztMUb4qmqPZy32ycTF8uwoUBG73/u2zf1ueWkthyfVkJeXnGOtG5Kj4ci31bHKjAZXppLhYOkIxYVbdlRdzvmOs5KmQk4VfbzbE8Fg9lVWyevXz1+fP/AeOM8GUE4gAA"; \ No newline at end of file diff --git a/classes/Classes.CollectionAccessor.html b/classes/Classes.CollectionAccessor.html index de77e74..36dcedc 100644 --- a/classes/Classes.CollectionAccessor.html +++ b/classes/Classes.CollectionAccessor.html @@ -1,19 +1,19 @@ -CollectionAccessor | SuperCamo - v1.0.5

Class CollectionAccessor

The data structure used by NedbClients to manage their collections of documents.

+CollectionAccessor | SuperCamo - v1.0.5

Class CollectionAccessor

The data structure used by NedbClients to manage their collections of documents.

The path and datastore are used in the actual persisting of the data by NeDB.

The name and model are used by SuperCamo to determine what document rules to apply to the collection's data.

This is not a class that you, as a user of the SuperCamo package, will typically interact with or use directly at all.

Author

BigfootDS

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

datastore model name path -

Constructors

constructor

Properties

datastore

datastore: Nedb<Record<string, any>>

Reference to the NeDB Datastore object for this collection.

+

Constructors

constructor

Properties

datastore

datastore: Nedb<Record<string, any>>

Reference to the NeDB Datastore object for this collection.

Author

BigfootDS

-

model

model: typeof NedbDocument

Reference to the NedbDocument-inheriting class used to define the collection's data structure.

+

model

model: typeof NedbDocument

Reference to the NedbDocument-inheriting class used to define the collection's data structure.

Author

BigfootDS

-

name

name: string

Name of the collection.

+

name

name: string

Name of the collection.

Author

BigfootDS

-

path

path: string

Path to its ".db" NeDB file.

+

path

path: string

Path to its ".db" NeDB file.

Author

BigfootDS

-

Settings

Member Visibility

On This Page

Constructors
Properties
+

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/classes/Classes.CollectionListEntry.html b/classes/Classes.CollectionListEntry.html index 4758f41..13040b4 100644 --- a/classes/Classes.CollectionListEntry.html +++ b/classes/Classes.CollectionListEntry.html @@ -1,14 +1,14 @@ -CollectionListEntry | SuperCamo - v1.0.5

Class CollectionListEntry

The data structure used by NedbClients to initialise a collection when setting up a database connection.

+CollectionListEntry | SuperCamo - v1.0.5

Class CollectionListEntry

The data structure used by NedbClients to initialise a collection when setting up a database connection.

You, as a user of the SuperCamo package, will typically use this class when first connecting to a database - and no other times.

Example

let newClient = SuperCamo.clientConnect(
	"ExampleDatabase",
	"./ExampleDatabase/",
	[
		new CollectionListEntry("Users", User),
	]
);

Author

BigfootDS

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

model name -

Constructors

constructor

Properties

model

model: typeof NedbDocument

Reference to the NedbDocument-inheriting class used to define the collection's data structure.

+

Constructors

constructor

Properties

model

model: typeof NedbDocument

Reference to the NedbDocument-inheriting class used to define the collection's data structure.

Author

BigfootDS

-

name

name: string

Name of the collection.

+

name

name: string

Name of the collection.

Author

BigfootDS

-

Settings

Member Visibility

On This Page

Constructors
Properties
+

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/classes/Classes.NedbBaseDocument.html b/classes/Classes.NedbBaseDocument.html index 85668c8..41994fa 100644 --- a/classes/Classes.NedbBaseDocument.html +++ b/classes/Classes.NedbBaseDocument.html @@ -1,4 +1,4 @@ -NedbBaseDocument | SuperCamo - v1.0.5

Class NedbBaseDocumentAbstract

Hierarchy (view full)

Implements

Constructors

constructor +NedbBaseDocument | SuperCamo - v1.0.5

Class NedbBaseDocumentAbstract

Hierarchy (view full)

Implements

Constructors

constructor

Properties

rules

Accessors

collectionName data @@ -19,59 +19,59 @@ create

Constructors

constructor

Properties

rules

rules: {
    [key: string]: DocumentKeyRule;
}

Define your document's properties in here!

+

Properties

rules

rules: {
    [key: string]: DocumentKeyRule;
}

Define your document's properties in here!

Author

BigfootDS

-

Accessors

collectionName

Accessors

collectionName

  • get collectionName(): null | string

  • Read-only string containing the name of the database collection that this document instance comes from.

    If this is null, assume that this document instance does not represent any data stored in a database.

    Returns null | string

    Author

    BigfootDS

    -

data

data

parentDatabaseName

parentDatabaseName

Methods

delete

Methods

delete

  • delete(deleteReferences?, deepDeleteReferences?): Promise<number>

  • Delete this document from the database client that it lives in.

    If you're using a databaseless-document instance, this method will throw an error!

    Parameters

    • OptionaldeleteReferences: boolean

      Similar to deepDeleteReferences, but you can pick one or the other. If true, all referenced documents will also delete themselves. If those referenced documents also reference additional documents, those documents are unaffected and may become orphaned.

    • OptionaldeepDeleteReferences: boolean

      Similar to deleteReferences, but you can pick one or the other. If true, all referenced documents will also delete themselves and recursively delete any documents that they also reference.

    Returns Promise<number>

    Number of documents deleted. You'd want this to be just 1. Other functions may use this number to create a greater tally (eg. a database client's findAndDeleteMany method).

    Author

    BigfootDS

    -

postDelete

postDelete

  • postDelete(): Promise<void>

  • An asynchronous function or promise that runs whenever delete() is executed. Override this and customise it if you'd like!

    Returns Promise<void>

    Author

    BigfootDS

    -

postSave

postSave

  • postSave(): Promise<void>

  • An asynchronous function or promise that runs whenever save() is executed. Override this and customise it if you'd like!

    Returns Promise<void>

    Author

    BigfootDS

    -

postValidate

postValidate

  • postValidate(): Promise<void>

  • An asynchronous function or promise that runs whenever validate() is executed. Override this and customise it if you'd like!

    Returns Promise<void>

    Author

    BigfootDS

    -

preDelete

preDelete

  • preDelete(): Promise<void>

  • An asynchronous function or promise that runs whenever delete() is executed. Override this and customise it if you'd like!

    Returns Promise<void>

    Author

    BigfootDS

    -

preSave

preSave

  • preSave(): Promise<void>

  • An asynchronous function or promise that runs whenever save() is executed. Override this and customise it if you'd like!

    Returns Promise<void>

    Author

    BigfootDS

    -

preValidate

preValidate

  • preValidate(): Promise<void>

  • An asynchronous function or promise that runs whenever validate() is executed. Override this and customise it if you'd like!

    Returns Promise<void>

    Author

    BigfootDS

    -

save

save

  • save(): Promise<boolean>

  • Save the document to the database. If the document doesn't already exist in the database, it will be added to the database automatically.

    This function also runs any preSave and postSave methods defined on the document.

    Returns Promise<boolean>

    Author

    BigfootDS

    -

toJSON

toJSON

toObject

toObject

  • toObject(): object

  • This document instance's data, and only the data, organized onto an object.

    This does not retrieve any referenced document's data, it's just a shallow object representation of this own document!

    Returns object

    Object containing data from the document instance.

    Author

    BigfootDS

    -

toPopulatedObject

toPopulatedObject

toString

toString

validate

validate

  • validate(): Promise<boolean>

  • Run validation logic against the rules defined in the document's rules property.

    This function also runs any preValidate and postValidate methods defined on the document.

    Returns Promise<boolean>

    Author

    BigfootDS

    -

Staticcreate

Staticcreate

  • create<Type>(this, newData, newParentDatabaseName, newCollectionName, validateOnCreate?): Promise<Type>

  • Create an instance of the document's type. This does not write any data to a database.

    Type Parameters

    Parameters

    • this: (new (incomingData: object, incomingParentDatabaseName: string, incomingCollectionName: string) => Type)
        • new (incomingData, incomingParentDatabaseName, incomingCollectionName): Type

        • Parameters

          • incomingData: object
          • incomingParentDatabaseName: string
          • incomingCollectionName: string

          Returns Type

    • newData: object

      Object containing keys of data that the document requires per its schema.

    • newParentDatabaseName: string

      The name of the database/client that is managing this data.

    • newCollectionName: string

      The name of the collection that is using this document as a model for its data.

    • OptionalvalidateOnCreate: boolean = true

      Boolean flag for whether or not a document instance created with this method should be validated ASAP. Default is true.

    Returns Promise<Type>

    Author

    BigfootDS

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/Classes.NedbClient.html b/classes/Classes.NedbClient.html index 724b638..7d0b23f 100644 --- a/classes/Classes.NedbClient.html +++ b/classes/Classes.NedbClient.html @@ -1,4 +1,4 @@ -NedbClient | SuperCamo - v1.0.5

Class NedbClient

Implements

Constructors

constructor +NedbClient | SuperCamo - v1.0.5

Class NedbClient

Implements

Constructors

constructor

Properties

collections documents embeddedDocuments @@ -31,90 +31,90 @@
  • dbDirectoryPath: string

    The folder path for where the database and its collections will be stored.

  • collectionsList: CollectionListEntry[]

    An array of collections, where each item in this array is an object containing the name of the collection and the model or document that the collection will use.

    • Returns NedbClient

    Author

    BigfootDS

    -

    Properties

    collections

    collections: CollectionAccessor[] = []

    A list of meta-objects defining categories of documents in the database.

    +

    Properties

    collections

    collections: CollectionAccessor[] = []

    A list of meta-objects defining categories of documents in the database.

    A collection is an object containing a collection name, document type, plus other properties to help access that data. This means that multiple collections could use the same document type while still keeping database records in separate collections in the database.

    Author

    BigfootDS

    -

    documents

    documents: typeof NedbDocument[] = []

    The set of document types used in this database.

    +

    documents

    documents: typeof NedbDocument[] = []

    The set of document types used in this database.

    This is calculated based on the collections that the database is configured to use, since multiple collections could use the same document type.

    Author

    BigfootDS

    -

    embeddedDocuments

    embeddedDocuments: typeof NedbEmbeddedDocument[] = []

    The set of embedded-document types used in this database.

    +

    embeddedDocuments

    embeddedDocuments: typeof NedbEmbeddedDocument[] = []

    The set of embedded-document types used in this database.

    This is calculated based on the collections that the database is configured to use, since multiple collections could use the same embedded-document type.

    Author

    BigfootDS

    -

    name

    name: string = ""

    The name of the database.

    +

    name

    name: string = ""

    The name of the database.

    Author

    BigfootDS

    -

    path

    path: string = ""

    The database's folder path, where it stores all collections.

    +

    path

    path: string = ""

    The database's folder path, where it stores all collections.

    Author

    BigfootDS

    -

    Methods

    count

    Methods

    count

    • count(collectionName, query): Promise<number>

    • Query a collection and receive a number representing the count of documents matching that query.

      Parameters

      • collectionName: string

        The name of the collection that you wish search through.

      • query: object

        The NeDB query used to find the specific document within the collection.

      Returns Promise<number>

      Integer number of documents within the specified collection that match the query.

      Author

      BigfootDS

      -

    createCollection

    createCollection

    createIndex

    createIndex

    • createIndex(collectionName, indexOptions): Promise<void>

    • Configure an enforced constraint on a collection.

      See the @seald/nedb documentation for more info about NeDB indexes.

      Parameters

      • collectionName: string

        A string of the collection name to target within the database.

      • indexOptions: EnsureIndexOptions

        An object per the @seald/nedb documentation to configure the index that is to be created.

      Returns Promise<void>

      Promise.

      Author

      BigfootDS

      -

    createMany

    • createMany(collectionName, dataObjectArray): Promise<NedbDocument[]>

    • Create multiple document instances from a provided array of object data, insert each document instance into the database, and return the array of document instances.

      +

    createMany

    • createMany(collectionName, dataObjectArray): Promise<NedbDocument[]>

    • Create multiple document instances from a provided array of object data, insert each document instance into the database, and return the array of document instances.

      Parameters

      • collectionName: string
      • dataObjectArray: object[]

      Returns Promise<NedbDocument[]>

      Author

      BigfootDS

      -

    createOne

    • createOne(collectionName, dataObject): Promise<NedbDocument>

    • Create a document instance from a provided object of data, insert the new document instance into the database, and return the new document instance.

      +

    createOne

    • createOne(collectionName, dataObject): Promise<NedbDocument>

    • Create a document instance from a provided object of data, insert the new document instance into the database, and return the new document instance.

      Parameters

      • collectionName: string
      • dataObject: object

      Returns Promise<NedbDocument>

      Author

      BigfootDS

      -

    deleteCollectionByModel

    deleteCollectionByModel

    • deleteCollectionByModel(model, deleteData?): Promise<number>

    • Delete collections by model. Can delete multiple collections that use the same model.

      You can also specify whether or not the data within the collection should be deleted, just as a sanity-check. This is enabled by default.

      Parameters

      • model: typeof NedbDocument

        The model to search for.

      • OptionaldeleteData: boolean = true

        Whether or not data within the collection should be deleted. Defaults to true.

      Returns Promise<number>

      The number of collections with a matching name that were deleted.

      Author

      BigfootDS

      -

    deleteCollectionByName

    deleteCollectionByName

    • deleteCollectionByName(name, deleteData?): Promise<number>

    • Delete collections by name. Can delete multiple collections that use the same name.

      You can also specify whether or not the data within the collection should be deleted, just as a sanity-check. This is enabled by default.

      Parameters

      • name: string

        The name of the collections to search for.

      • OptionaldeleteData: boolean = true

        Whether or not data within the collection should be deleted. Defaults to true.

      Returns Promise<number>

      The number of collections with a matching name that were deleted.

      Author

      BigfootDS

      -

    dropDatabase

    dropDatabase

    • dropDatabase(): Promise<void>

    • Delete all documents in all collections within this database. Highly destructive. Could use more work.

      Returns Promise<void>

      Author

      BigfootDS

      -

    findAndDeleteMany

    findAndDeleteMany

    • findAndDeleteMany(collectionName, query, options?): Promise<number>

    • Find and delete multiple documents from a specified collection.

      Parameters

      • collectionName: string

        The name of the collection that you wish to search through and modify.

      • query: object

        The NeDB query used to find the specific documents within the collection.

      • options: RemoveOptions = ...

        Options to pass to the query system in NeDB. For this particular method, multi is always set to true.

      Returns Promise<number>

      Number of removed documents.

      Author

      BigfootDS

      -

    findAndDeleteOne

    findAndDeleteOne

    • findAndDeleteOne(collectionName, query, options?): Promise<number>

    • Find and delete one document from a specified collection.

      Parameters

      • collectionName: string

        The name of the collection that you wish to search through and modify.

      • query: object

        The NeDB query used to find the specific document within the collection.

      • options: RemoveOptions = ...

        Options to pass to the query system in NeDB. For this particular method, multi is always set to false.

      Returns Promise<number>

      Number of removed documents.

      Author

      BigfootDS

      -

    findAndUpdateManyDocuments

    • findAndUpdateManyDocuments(collectionName, query, newData, options?): Promise<NedbDocument[]>

    • Search a database for one or more matched documents and modify them, returning the modified documents as an array of document instances.

      +

    findAndUpdateManyDocuments

    • findAndUpdateManyDocuments(collectionName, query, newData, options?): Promise<NedbDocument[]>

    • Search a database for one or more matched documents and modify them, returning the modified documents as an array of document instances.

      If no documents match the given query, this function will return an empty array.

      Parameters

      • collectionName: string

        The name of the database collection to query.

      • query: object

        The query to run to find the relevant document.

      • newData: object

        The data to apply to the found document.

      • Optionaloptions: updateManyOptions

        Optional. The options that can be used in this operation.

      Returns Promise<NedbDocument[]>

      Author

      BigfootDS

      -

    findAndUpdateManyObjects

    • findAndUpdateManyObjects(collectionName, query, newData, options?): Promise<object[]>

    • Search a database for one or more matched documents and modify them, returning the modified documents as an array of plain objects.

      +

    findAndUpdateManyObjects

    • findAndUpdateManyObjects(collectionName, query, newData, options?): Promise<object[]>

    • Search a database for one or more matched documents and modify them, returning the modified documents as an array of plain objects.

      If no documents match the given query, this function will return an empty array.

      Parameters

      • collectionName: string

        The name of the database collection to query.

      • query: object

        The query to run to find the relevant document.

      • newData: object

        The data to apply to the found document.

      • Optionaloptions: updateManyOptions

        Optional. The options that can be used in this operation.

      Returns Promise<object[]>

      Author

      BigfootDS

      -

    findAndUpdateOneDocument

    • findAndUpdateOneDocument(collectionName, query, newData, options?): Promise<null | NedbDocument>

    • Search a database for a singular matched document and modify it, returning the modified document as a document instance.

      +

    findAndUpdateOneDocument

    • findAndUpdateOneDocument(collectionName, query, newData, options?): Promise<null | NedbDocument>

    • Search a database for a singular matched document and modify it, returning the modified document as a document instance.

      Parameters

      • collectionName: string

        The name of the database collection to query.

      • query: object

        The query to run to find the relevant document.

      • newData: object

        The data to apply to the found document.

      • Optionaloptions: updateOptions

        Optional. The options that can be used in this operation.

      Returns Promise<null | NedbDocument>

      Author

      BigfootDS

      -

    findAndUpdateOneObject

    • findAndUpdateOneObject(collectionName, query, newData, options?): Promise<null | object>

    • Search a database for a singular matched document and modify it, returning the modified document as a plain object.

      +

    findAndUpdateOneObject

    • findAndUpdateOneObject(collectionName, query, newData, options?): Promise<null | object>

    • Search a database for a singular matched document and modify it, returning the modified document as a plain object.

      Parameters

      • collectionName: string

        The name of the database collection to query.

      • query: object

        The query to run to find the relevant document.

      • newData: object

        The data to apply to the found document.

      • Optionaloptions: updateOptions

        Optional. The options that can be used in this operation.

      Returns Promise<null | object>

      Author

      BigfootDS

      -

    findManyDocuments

    findManyDocuments

    • findManyDocuments(collectionName, query, options?): Promise<NedbDocument[]>

    • Query a collection and return an array of document instances matching that query.

      This method is NOT compatible with NeDB projections.

      Even if nothing matches the given query, an array is returned.

      Parameters

      • collectionName: string

        The name of the collection that you wish to search through.

        @@ -122,7 +122,7 @@
      • Optionaloptions: findManyDocumentsOptions

        Optional. Configuration for this database operation.

      Returns Promise<NedbDocument[]>

      An instance of the collection's model.

      Author

      BigfootDS

      -

    findManyObjects

    • findManyObjects(collectionName, query, options?): Promise<object[]>

    • Query a collection and return an array of objects matching that query, where each object is a document's data.

      +

    findManyObjects

    • findManyObjects(collectionName, query, options?): Promise<object[]>

    • Query a collection and return an array of objects matching that query, where each object is a document's data.

      This method is compatible with NeDB projections, allowing you to trim the returned data. Read more in the NeDB documentation.

      Even if nothing matches the given query, an array is returned.

      Parameters

      • collectionName: string

        The name of the collection that you wish to search through.

        @@ -130,36 +130,36 @@
      • Optionaloptions: findManyObjectsOptions

        Optional. Configuration for this database operation.

      Returns Promise<object[]>

      An instance of the collection's model.

      Author

      BigfootDS

      -

    findOneDocument

    findOneDocument

    • findOneDocument(collectionName, query): Promise<null | NedbDocument>

    • Query a collection and receive the first document matching that query, returned as a document instance.

      This method is NOT compatible with NeDB projections, and thus returns an instance of the document used by the specified collection.

      Parameters

      Returns Promise<null | NedbDocument>

      An instance of the collection's model.

      Author

      BigfootDS

      -

    findOneObject

    • findOneObject(collectionName, query, options?): Promise<null | object>

    • Query a collection and receive the first document matching that query, returned as a plain object.

      +

    findOneObject

    • findOneObject(collectionName, query, options?): Promise<null | object>

    • Query a collection and receive the first document matching that query, returned as a plain object.

      This method is compatible with NeDB projections, allowing you to trim the returned data. Read more in the NeDB documentation.

      Parameters

      Returns Promise<null | object>

      An instance of the collection's model.

      Author

      BigfootDS

      -

    getCollectionAccessor

    getCollectionAccessor

    • getCollectionAccessor(collectionName): CollectionAccessor

    • Retrieve the collection meta object stored on the NeDB client instance matching a given collection name.

      Parameters

      • collectionName: string

        A string of the collection name to target within the database.

      Returns CollectionAccessor

      An object containing helper properties to perform collection-related operations.

      Author

      BigfootDS

      -

    insertMany

    • insertMany(collectionName, dataObjectArray): Promise<object[]>

    • Insert an array of objects of data into the database, following a document schema, and return the saved array of objects of data.

      +

    insertMany

    • insertMany(collectionName, dataObjectArray): Promise<object[]>

    • Insert an array of objects of data into the database, following a document schema, and return the saved array of objects of data.

      Parameters

      • collectionName: string

        The name of the collection to insert the data into.

      • dataObjectArray: object[]

        The data to be inserted.

      Returns Promise<object[]>

      The data saved in the database, as an object.

      Author

      BigfootDS

      -

    insertOne

    • insertOne(collectionName, dataObject): Promise<object>

    • Insert an object of data into the database, following a document schema, and return the saved object of data.

      +

    insertOne

    • insertOne(collectionName, dataObject): Promise<object>

    • Insert an object of data into the database, following a document schema, and return the saved object of data.

      Parameters

      • collectionName: string

        The name of the collection to insert the data into.

      • dataObject: object

        The data to be inserted.

      Returns Promise<object>

      The data saved in the database, as an object.

      Author

      BigfootDS

      -

    removeIndex

    removeIndex

    • removeIndex(collectionName, fieldNames): Promise<void>

    • Remove a collection's index from an array of given field names.

      Parameters

      • collectionName: string

        A string of the collection name to target within the database.

      • fieldNames: string[]

        An array containing one or more fields on the collection that you'd like to remove the index from.

      Returns Promise<void>

      Promise.

      Author

      BigfootDS

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Classes.NedbDocument.html b/classes/Classes.NedbDocument.html index dd86074..012c134 100644 --- a/classes/Classes.NedbDocument.html +++ b/classes/Classes.NedbDocument.html @@ -1,4 +1,4 @@ -NedbDocument | SuperCamo - v1.0.5

    Class NedbDocument

    Hierarchy (view full)

    Constructors

    constructor +NedbDocument | SuperCamo - v1.0.5

    Class NedbDocument

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    rules

    Accessors

    collectionName data @@ -17,59 +17,59 @@ toString validate create -

    Constructors

    constructor

    Properties

    rules

    rules: {
        [key: string]: DocumentKeyRule;
    }

    Define your document's properties in here!

    +

    Constructors

    constructor

    Properties

    rules

    rules: {
        [key: string]: DocumentKeyRule;
    }

    Define your document's properties in here!

    Author

    BigfootDS

    -

    Accessors

    collectionName

    Accessors

    collectionName

    • get collectionName(): null | string

    • Read-only string containing the name of the database collection that this document instance comes from.

      If this is null, assume that this document instance does not represent any data stored in a database.

      Returns null | string

      Author

      BigfootDS

      -

    data

    data

    parentDatabaseName

    parentDatabaseName

    • get parentDatabaseName(): null | string

    • Read-only string containing the name of the database that this document instance comes from.

      If this is null, assume that this document instance does not represent any data stored in a database.

      Returns null | string

      Author

      BigfootDS

      -

    Methods

    delete

    • delete(deleteReferences?, deepDeleteReferences?): Promise<number>

    • Delete this document from the database client that it lives in.

      +

    Methods

    delete

    • delete(deleteReferences?, deepDeleteReferences?): Promise<number>

    • Delete this document from the database client that it lives in.

      If you're using a databaseless-document instance, this method will throw an error!

      Parameters

      • OptionaldeleteReferences: boolean

        Similar to deepDeleteReferences, but you can pick one or the other. If true, all referenced documents will also delete themselves. If those referenced documents also reference additional documents, those documents are unaffected and may become orphaned.

      • OptionaldeepDeleteReferences: boolean

        Similar to deleteReferences, but you can pick one or the other. If true, all referenced documents will also delete themselves and recursively delete any documents that they also reference.

      Returns Promise<number>

      Number of documents deleted. You'd want this to be just 1. Other functions may use this number to create a greater tally (eg. a database client's findAndDeleteMany method).

      Author

      BigfootDS

      -

    postDelete

    postDelete

    postSave

    postSave

    postValidate

    postValidate

    preDelete

    preDelete

    preSave

    preSave

    preValidate

    preValidate

    save

    save

    • save(): Promise<boolean>

    • Save the document to the database. If the document doesn't already exist in the database, it will be added to the database automatically.

      This function also runs any preSave and postSave methods defined on the document.

      Returns Promise<boolean>

      Author

      BigfootDS

      -

    toJSON

    toJSON

    toObject

    toObject

    • toObject(): object

    • This document instance's data, and only the data, organized onto an object.

      This does not retrieve any referenced document's data, it's just a shallow object representation of this own document!

      Returns object

      Object containing data from the document instance.

      Author

      BigfootDS

      -

    toPopulatedObject

    toPopulatedObject

    toString

    toString

    validate

    validate

    Staticcreate

    Staticcreate

    • create<Type>(this, newData, newParentDatabaseName, newCollectionName, validateOnCreate?): Promise<Type>

    • Create an instance of the document's type. This does not write any data to a database.

      Type Parameters

      Parameters

      • this: (new (incomingData: object, incomingParentDatabaseName: string, incomingCollectionName: string) => Type)
          • new (incomingData, incomingParentDatabaseName, incomingCollectionName): Type

          • Parameters

            • incomingData: object
            • incomingParentDatabaseName: string
            • incomingCollectionName: string

            Returns Type

      • newData: object

        Object containing keys of data that the document requires per its schema.

      • newParentDatabaseName: string

        The name of the database/client that is managing this data.

      • newCollectionName: string

        The name of the collection that is using this document as a model for its data.

      • OptionalvalidateOnCreate: boolean = true

        Boolean flag for whether or not a document instance created with this method should be validated ASAP. Default is true.

      Returns Promise<Type>

      Author

      BigfootDS

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/Classes.NedbEmbeddedDocument.html b/classes/Classes.NedbEmbeddedDocument.html index 21c5d73..f99291b 100644 --- a/classes/Classes.NedbEmbeddedDocument.html +++ b/classes/Classes.NedbEmbeddedDocument.html @@ -1,4 +1,4 @@ -NedbEmbeddedDocument | SuperCamo - v1.0.5

    Class NedbEmbeddedDocument

    Hierarchy (view full)

    Constructors

    constructor +NedbEmbeddedDocument | SuperCamo - v1.0.5

    Class NedbEmbeddedDocument

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    rules

    Accessors

    collectionName data @@ -17,59 +17,59 @@ toString validate create -

    Constructors

    constructor

    Properties

    rules

    rules: {
        [key: string]: DocumentKeyRule;
    }

    Define your document's properties in here!

    +

    Constructors

    constructor

    Properties

    rules

    rules: {
        [key: string]: DocumentKeyRule;
    }

    Define your document's properties in here!

    Author

    BigfootDS

    -

    Accessors

    collectionName

    Accessors

    collectionName

    • get collectionName(): null | string

    • Read-only string containing the name of the database collection that this document instance comes from.

      If this is null, assume that this document instance does not represent any data stored in a database.

      Returns null | string

      Author

      BigfootDS

      -

    data

    data

    parentDatabaseName

    parentDatabaseName

    • get parentDatabaseName(): null | string

    • Read-only string containing the name of the database that this document instance comes from.

      If this is null, assume that this document instance does not represent any data stored in a database.

      Returns null | string

      Author

      BigfootDS

      -

    Methods

    delete

    • delete(deleteReferences?, deepDeleteReferences?): Promise<number>

    • Delete this document from the database client that it lives in.

      +

    Methods

    delete

    • delete(deleteReferences?, deepDeleteReferences?): Promise<number>

    • Delete this document from the database client that it lives in.

      If you're using a databaseless-document instance, this method will throw an error!

      Parameters

      • OptionaldeleteReferences: boolean

        Similar to deepDeleteReferences, but you can pick one or the other. If true, all referenced documents will also delete themselves. If those referenced documents also reference additional documents, those documents are unaffected and may become orphaned.

      • OptionaldeepDeleteReferences: boolean

        Similar to deleteReferences, but you can pick one or the other. If true, all referenced documents will also delete themselves and recursively delete any documents that they also reference.

      Returns Promise<number>

      Number of documents deleted. You'd want this to be just 1. Other functions may use this number to create a greater tally (eg. a database client's findAndDeleteMany method).

      Author

      BigfootDS

      -

    postDelete

    postDelete

    postSave

    postSave

    postValidate

    postValidate

    preDelete

    preDelete

    preSave

    preSave

    preValidate

    preValidate

    save

    save

    • save(): Promise<boolean>

    • Save the document to the database. If the document doesn't already exist in the database, it will be added to the database automatically.

      This function also runs any preSave and postSave methods defined on the document.

      Returns Promise<boolean>

      Author

      BigfootDS

      -

    toJSON

    toJSON

    toObject

    toObject

    • toObject(): object

    • This document instance's data, and only the data, organized onto an object.

      This does not retrieve any referenced document's data, it's just a shallow object representation of this own document!

      Returns object

      Object containing data from the document instance.

      Author

      BigfootDS

      -

    toPopulatedObject

    toPopulatedObject

    toString

    toString

    validate

    validate

    Staticcreate

    Staticcreate

    • create<Type>(this, newData, newParentDatabaseName, newCollectionName, validateOnCreate?): Promise<Type>

    • Create an instance of the document's type. This does not write any data to a database.

      Type Parameters

      Parameters

      • this: (new (incomingData: object, incomingParentDatabaseName: string, incomingCollectionName: string) => Type)
          • new (incomingData, incomingParentDatabaseName, incomingCollectionName): Type

          • Parameters

            • incomingData: object
            • incomingParentDatabaseName: string
            • incomingCollectionName: string

            Returns Type

      • newData: object

        Object containing keys of data that the document requires per its schema.

      • newParentDatabaseName: string

        The name of the database/client that is managing this data.

      • newCollectionName: string

        The name of the collection that is using this document as a model for its data.

      • OptionalvalidateOnCreate: boolean = true

        Boolean flag for whether or not a document instance created with this method should be validated ASAP. Default is true.

      Returns Promise<Type>

      Author

      BigfootDS

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/Classes.SuperCamo.html b/classes/Classes.SuperCamo.html index fa4cd21..9e94def 100644 --- a/classes/Classes.SuperCamo.html +++ b/classes/Classes.SuperCamo.html @@ -1,4 +1,4 @@ -SuperCamo | SuperCamo - v1.0.5

    Class SuperCamo

    Properties

    clients +SuperCamo | SuperCamo - v1.0.5

    Class SuperCamo

    Properties

    clients

    Accessors

    clientList

    Methods

    clientConnect clientDelete @@ -9,25 +9,25 @@

    Example

    	let pokemonDatabase = SuperCamo.clientConnect(
    		"Pokemon Database", 
    		"./Storage", 
    		[
    			new CollectionListEntry("Users", User),
    			new CollectionListEntry("CapturedPokemon", Pokemon),
    			new CollectionListEntry("WildPokemon", Pokemon)
    		]
    );
    -

    Accessors

    StaticclientList

    Accessors

    StaticclientList

    Methods

    StaticclientConnect

    Methods

    StaticclientConnect

    • clientConnect(databaseName, databaseDirectory?, collectionsList?, clientType?): NedbClient

    • Create a database client instance, connecting to it and returning its instance.

      Parameters

      • databaseName: string

        A unique name for the database.

      • OptionaldatabaseDirectory: string = ""

        The folder path for where the database and its collections will be stored.

      • OptionalcollectionsList: CollectionsListEntry[] = []

        An array of collections, where each item in this array is an object containing the name of the collection and the model or document that the collection will use.

      • OptionalclientType: typeof NedbClient = NedbClient

        A custom type of database client, though you can leave this blank to use the default SuperCamo database client.

      Returns NedbClient

      The newly-created database client instance.

      Author

      BigfootDS

      -

    StaticclientDelete

    StaticclientDelete

    • clientDelete(targetClient): number

    • Disconnect from the specified database AND delete its files. This is extremely destructive! Be careful!

      Parameters

      • targetClient: string

        The name of the database that you wish to disconnect from.

      Returns number

      Number of clients disconnected.

      Author

      BigfootDS

      -

    StaticclientDisconnect

    StaticclientDisconnect

    • clientDisconnect(targetClient): number

    • Disconnect from the specified database.

      Parameters

      • targetClient: string

        The name of the database that you wish to disconnect from.

      Returns number

      Number of clients disconnected.

      Author

      BigfootDS

      -

    StaticclientGet

    StaticclientGet

    • clientGet(targetClient): null | NedbClient

    • Create an accessor for a database that is connected in the app.

      Parameters

      • targetClient: string

        The name of the database that you wish to connect to.

      Returns null | NedbClient

      A NedbClient instance.

      Author

      BigfootDS

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    diff --git a/classes/Error_Classes.CollectionAccessError.html b/classes/Error_Classes.CollectionAccessError.html index 81fcd17..3b427c8 100644 --- a/classes/Error_Classes.CollectionAccessError.html +++ b/classes/Error_Classes.CollectionAccessError.html @@ -1,11 +1,11 @@ -CollectionAccessError | SuperCamo - v1.0.5

    Class CollectionAccessError

    Hierarchy

    • Error
      • CollectionAccessError

    Constructors

    constructor +CollectionAccessError | SuperCamo - v1.0.5

    Class CollectionAccessError

    Hierarchy

    • Error
      • CollectionAccessError

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.DeleteFailure.html b/classes/Error_Classes.DeleteFailure.html index a27be97..ce95d3f 100644 --- a/classes/Error_Classes.DeleteFailure.html +++ b/classes/Error_Classes.DeleteFailure.html @@ -1,11 +1,11 @@ -DeleteFailure | SuperCamo - v1.0.5

    Class DeleteFailure

    Hierarchy

    • Error
      • DeleteFailure

    Constructors

    constructor +DeleteFailure | SuperCamo - v1.0.5

    Class DeleteFailure

    Hierarchy

    • Error
      • DeleteFailure

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.PostDeleteFailure.html b/classes/Error_Classes.PostDeleteFailure.html index 6f97ee5..a15ca44 100644 --- a/classes/Error_Classes.PostDeleteFailure.html +++ b/classes/Error_Classes.PostDeleteFailure.html @@ -1,11 +1,11 @@ -PostDeleteFailure | SuperCamo - v1.0.5

    Class PostDeleteFailure

    Hierarchy

    • Error
      • PostDeleteFailure

    Constructors

    constructor +PostDeleteFailure | SuperCamo - v1.0.5

    Class PostDeleteFailure

    Hierarchy

    • Error
      • PostDeleteFailure

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.PostSaveFailure.html b/classes/Error_Classes.PostSaveFailure.html index 1eb9d64..76b75e9 100644 --- a/classes/Error_Classes.PostSaveFailure.html +++ b/classes/Error_Classes.PostSaveFailure.html @@ -1,11 +1,11 @@ -PostSaveFailure | SuperCamo - v1.0.5

    Class PostSaveFailure

    Hierarchy

    • Error
      • PostSaveFailure

    Constructors

    constructor +PostSaveFailure | SuperCamo - v1.0.5

    Class PostSaveFailure

    Hierarchy

    • Error
      • PostSaveFailure

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.PostValidationFailure.html b/classes/Error_Classes.PostValidationFailure.html index 3735908..26bd5b9 100644 --- a/classes/Error_Classes.PostValidationFailure.html +++ b/classes/Error_Classes.PostValidationFailure.html @@ -1,11 +1,11 @@ -PostValidationFailure | SuperCamo - v1.0.5

    Class PostValidationFailure

    Hierarchy

    • Error
      • PostValidationFailure

    Constructors

    constructor +PostValidationFailure | SuperCamo - v1.0.5

    Class PostValidationFailure

    Hierarchy

    • Error
      • PostValidationFailure

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.PreDeleteFailure.html b/classes/Error_Classes.PreDeleteFailure.html index d5bc8d2..32b61eb 100644 --- a/classes/Error_Classes.PreDeleteFailure.html +++ b/classes/Error_Classes.PreDeleteFailure.html @@ -1,11 +1,11 @@ -PreDeleteFailure | SuperCamo - v1.0.5

    Class PreDeleteFailure

    Hierarchy

    • Error
      • PreDeleteFailure

    Constructors

    constructor +PreDeleteFailure | SuperCamo - v1.0.5

    Class PreDeleteFailure

    Hierarchy

    • Error
      • PreDeleteFailure

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.PreSaveFailure.html b/classes/Error_Classes.PreSaveFailure.html index 2c12600..534a2f6 100644 --- a/classes/Error_Classes.PreSaveFailure.html +++ b/classes/Error_Classes.PreSaveFailure.html @@ -1,11 +1,11 @@ -PreSaveFailure | SuperCamo - v1.0.5

    Class PreSaveFailure

    Hierarchy

    • Error
      • PreSaveFailure

    Constructors

    constructor +PreSaveFailure | SuperCamo - v1.0.5

    Class PreSaveFailure

    Hierarchy

    • Error
      • PreSaveFailure

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.PreValidationFailure.html b/classes/Error_Classes.PreValidationFailure.html index d037a52..02c3e4c 100644 --- a/classes/Error_Classes.PreValidationFailure.html +++ b/classes/Error_Classes.PreValidationFailure.html @@ -1,11 +1,11 @@ -PreValidationFailure | SuperCamo - v1.0.5

    Class PreValidationFailure

    Hierarchy

    • Error
      • PreValidationFailure

    Constructors

    constructor +PreValidationFailure | SuperCamo - v1.0.5

    Class PreValidationFailure

    Hierarchy

    • Error
      • PreValidationFailure

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.SaveFailure.html b/classes/Error_Classes.SaveFailure.html index 510353f..86aeade 100644 --- a/classes/Error_Classes.SaveFailure.html +++ b/classes/Error_Classes.SaveFailure.html @@ -1,11 +1,11 @@ -SaveFailure | SuperCamo - v1.0.5

    Class SaveFailure

    Hierarchy

    • Error
      • SaveFailure

    Constructors

    constructor +SaveFailure | SuperCamo - v1.0.5

    Class SaveFailure

    Hierarchy

    • Error
      • SaveFailure

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.ValidationFailure.html b/classes/Error_Classes.ValidationFailure.html index d329cd8..287f161 100644 --- a/classes/Error_Classes.ValidationFailure.html +++ b/classes/Error_Classes.ValidationFailure.html @@ -1,11 +1,11 @@ -ValidationFailure | SuperCamo - v1.0.5

    Class ValidationFailure

    Hierarchy

    • Error
      • ValidationFailure

    Constructors

    constructor +ValidationFailure | SuperCamo - v1.0.5

    Class ValidationFailure

    Hierarchy

    • Error
      • ValidationFailure

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.ValidationFailureMinMaxError.html b/classes/Error_Classes.ValidationFailureMinMaxError.html index 5c7fd30..05fcf52 100644 --- a/classes/Error_Classes.ValidationFailureMinMaxError.html +++ b/classes/Error_Classes.ValidationFailureMinMaxError.html @@ -1,11 +1,11 @@ -ValidationFailureMinMaxError | SuperCamo - v1.0.5

    Class ValidationFailureMinMaxError

    Hierarchy

    • Error
      • ValidationFailureMinMaxError

    Constructors

    constructor +ValidationFailureMinMaxError | SuperCamo - v1.0.5

    Class ValidationFailureMinMaxError

    Hierarchy

    • Error
      • ValidationFailureMinMaxError

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.ValidationFailureMissingValueForProperty.html b/classes/Error_Classes.ValidationFailureMissingValueForProperty.html index 681795c..ae7f750 100644 --- a/classes/Error_Classes.ValidationFailureMissingValueForProperty.html +++ b/classes/Error_Classes.ValidationFailureMissingValueForProperty.html @@ -1,11 +1,11 @@ -ValidationFailureMissingValueForProperty | SuperCamo - v1.0.5

    Class ValidationFailureMissingValueForProperty

    Hierarchy

    • Error
      • ValidationFailureMissingValueForProperty

    Constructors

    constructor +ValidationFailureMissingValueForProperty | SuperCamo - v1.0.5

    Class ValidationFailureMissingValueForProperty

    Hierarchy

    • Error
      • ValidationFailureMissingValueForProperty

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.ValidationFailureMissingValueForReferencedDoc.html b/classes/Error_Classes.ValidationFailureMissingValueForReferencedDoc.html index 8ff5779..0db39c0 100644 --- a/classes/Error_Classes.ValidationFailureMissingValueForReferencedDoc.html +++ b/classes/Error_Classes.ValidationFailureMissingValueForReferencedDoc.html @@ -1,11 +1,11 @@ -ValidationFailureMissingValueForReferencedDoc | SuperCamo - v1.0.5

    Class ValidationFailureMissingValueForReferencedDoc

    Hierarchy

    • Error
      • ValidationFailureMissingValueForReferencedDoc

    Constructors

    constructor +ValidationFailureMissingValueForReferencedDoc | SuperCamo - v1.0.5

    Class ValidationFailureMissingValueForReferencedDoc

    Hierarchy

    • Error
      • ValidationFailureMissingValueForReferencedDoc

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.ValidationFailureReferenceWithoutDatabase.html b/classes/Error_Classes.ValidationFailureReferenceWithoutDatabase.html index 2c27bf6..30eb6af 100644 --- a/classes/Error_Classes.ValidationFailureReferenceWithoutDatabase.html +++ b/classes/Error_Classes.ValidationFailureReferenceWithoutDatabase.html @@ -1,11 +1,11 @@ -ValidationFailureReferenceWithoutDatabase | SuperCamo - v1.0.5

    Class ValidationFailureReferenceWithoutDatabase

    Hierarchy

    • Error
      • ValidationFailureReferenceWithoutDatabase

    Constructors

    constructor +ValidationFailureReferenceWithoutDatabase | SuperCamo - v1.0.5

    Class ValidationFailureReferenceWithoutDatabase

    Hierarchy

    • Error
      • ValidationFailureReferenceWithoutDatabase

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.ValidationFailureUnexpectedProperty.html b/classes/Error_Classes.ValidationFailureUnexpectedProperty.html index 8510cba..42fad17 100644 --- a/classes/Error_Classes.ValidationFailureUnexpectedProperty.html +++ b/classes/Error_Classes.ValidationFailureUnexpectedProperty.html @@ -1,11 +1,11 @@ -ValidationFailureUnexpectedProperty | SuperCamo - v1.0.5

    Class ValidationFailureUnexpectedProperty

    Hierarchy

    • Error
      • ValidationFailureUnexpectedProperty

    Constructors

    constructor +ValidationFailureUnexpectedProperty | SuperCamo - v1.0.5

    Class ValidationFailureUnexpectedProperty

    Hierarchy

    • Error
      • ValidationFailureUnexpectedProperty

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Error_Classes.ValidationFailureValueNotInChoices.html b/classes/Error_Classes.ValidationFailureValueNotInChoices.html index 3a0be1f..306185c 100644 --- a/classes/Error_Classes.ValidationFailureValueNotInChoices.html +++ b/classes/Error_Classes.ValidationFailureValueNotInChoices.html @@ -1,11 +1,11 @@ -ValidationFailureValueNotInChoices | SuperCamo - v1.0.5

    Class ValidationFailureValueNotInChoices

    Hierarchy

    • Error
      • ValidationFailureValueNotInChoices

    Constructors

    constructor +ValidationFailureValueNotInChoices | SuperCamo - v1.0.5

    Class ValidationFailureValueNotInChoices

    Hierarchy

    • Error
      • ValidationFailureValueNotInChoices

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/documents/Quick_Start.html b/documents/Quick_Start.html index ebe6545..4028ed1 100644 --- a/documents/Quick_Start.html +++ b/documents/Quick_Start.html @@ -1,4 +1,4 @@ -Quick Start | SuperCamo - v1.0.5

    This is a NoSQL "ODM" built for usage with NeDB. You can define schemas for the data that you want to store in a NeDB database, and the objects that get used within NeDB will obey the rules and functionalities defined by your schemas.

    +Quick Start | SuperCamo - v1.0.5

    This is a NoSQL "ODM" built for usage with NeDB. You can define schemas for the data that you want to store in a NeDB database, and the objects that get used within NeDB will obey the rules and functionalities defined by your schemas.

    It's like how MongooseJS is for MongoDB - SuperCamo is for NeDB.

    Installation

    Install this package as a production dependency using this command:

    npm install @bigfootds/supercamo
diff --git a/documents/The_Basics.00___Understanding_This_Package.html b/documents/The_Basics.00___Understanding_This_Package.html
index 7acabed..8209abc 100644
--- a/documents/The_Basics.00___Understanding_This_Package.html
+++ b/documents/The_Basics.00___Understanding_This_Package.html
@@ -1,4 +1,4 @@
-00 - Understanding This Package | SuperCamo - v1.0.5
    SuperCamo is a package built as a wrapper around NeDB. It contains several key parts that you need to understand to really make good use of this package, and you would benefit from also digging around in NeDB package documentation - but we'll point that out when it's necessary in the other documentation pages.
    
+00 - Understanding This Package | SuperCamo - v1.0.5
    SuperCamo is a package built as a wrapper around NeDB. It contains several key parts that you need to understand to really make good use of this package, and you would benefit from also digging around in NeDB package documentation - but we'll point that out when it's necessary in the other documentation pages.
    
 
    This page will walk you through the key components of this package and briefly explain what they are, as well as when you need to use them.
    
 
    There are a lot of moving pieces in this system. In a nutshell:
    
 
    The SuperCamo singleton
    This package is all about making it easier to manage multiple NeDB database connections within a single app's lifetime. The SuperCamo singleton is how that happens.
    
diff --git a/documents/The_Basics.01___The_SuperCamo_Singleton.html b/documents/The_Basics.01___The_SuperCamo_Singleton.html
index af825ac..4680ece 100644
--- a/documents/The_Basics.01___The_SuperCamo_Singleton.html
+++ b/documents/The_Basics.01___The_SuperCamo_Singleton.html
@@ -1,4 +1,4 @@
-01 - The SuperCamo Singleton | SuperCamo - v1.0.5
    This package is all about making it easier to manage multiple NeDB database connections within a single app's lifetime. The SuperCamo singleton is how that happens.
    
+01 - The SuperCamo Singleton | SuperCamo - v1.0.5
    This package is all about making it easier to manage multiple NeDB database connections within a single app's lifetime. The SuperCamo singleton is how that happens.
    
 
    Essentially, you should connect to a database via the SuperCamo singleton. The SuperCamo.clientConnect() function returns a reference to the database client instance, and that same instance can be retrieved again in any file that uses the SuperCamo singleton too.
    
 
    This means that when your app runs, you should follow this process:
    
 
      
diff --git a/documents/The_Basics.02___Document_Basics.html b/documents/The_Basics.02___Document_Basics.html
index 2e85ca1..3c9b1c6 100644
--- a/documents/The_Basics.02___Document_Basics.html
+++ b/documents/The_Basics.02___Document_Basics.html
@@ -1,4 +1,4 @@
-02 - Document Basics | SuperCamo - v1.0.5
      NeDB is a NoSQL database. That means that instead of tables and rows to represent entities of data, we use collections of documents.
      
+02 - Document Basics | SuperCamo - v1.0.5
      NeDB is a NoSQL database. That means that instead of tables and rows to represent entities of data, we use collections of documents.
      
 
      Traditionally, one NeDB datastore is one collection. SuperCamo manages that for you, so you just have to assign a document and a collection name to a database client to make that work the same way you'd expect from popular NoSQL systems like MongoDB and MongooseJS.
      
 
      Declaring Documents
      Declaring a document is how you can define a schema or structure for your data.
      
 
      Like so:
      
diff --git a/documents/The_Basics.03___Embedded_Document_Basics.html b/documents/The_Basics.03___Embedded_Document_Basics.html
index 36f36c3..23df51c 100644
--- a/documents/The_Basics.03___Embedded_Document_Basics.html
+++ b/documents/The_Basics.03___Embedded_Document_Basics.html
@@ -1,4 +1,4 @@
-03 - Embedded Document Basics | SuperCamo - v1.0.5
      Subdocuments or embedded documents are a way of structuring complex data nested within documents. While a document can have objects as its properties/fields, it's typically more straightforward to create embedded documents to represent objects instead.
      
+03 - Embedded Document Basics | SuperCamo - v1.0.5
      Subdocuments or embedded documents are a way of structuring complex data nested within documents. While a document can have objects as its properties/fields, it's typically more straightforward to create embedded documents to represent objects instead.
      
 
      Declaring Embedded Documents
      Embedded documents have their own validation step, so you can configure validation rules in a declared embedded document and they will run when the document that contains the embedded document runs. Might sound hard to keep track of, but basically: embedded documents are identical to regular documents, except you cannot use embedded documents as standalone documents. They can only exist as properties within documents.
      
 
      For example:
      
 
      const {NedbEmbeddedDocument} = require('@bigfootds/supercamo');
      const ISO6391 = require('iso-639-1');
      let allowedLanguageCodes = ISO6391.getAllCodes();

      class LocalizedContent extends NedbEmbeddedDocument {
      	constructor(data, databaseName, collectionName){
      		super(data, databaseName, collectionName);

      		/**
      		 * A two-letter language code that matches the language of this subdocument's name and content.
      		 * Examples: "EN", "FR", "DE"
      		 * Refer to the ISO-639-1 standard online for the full list of usable codes.
      		 */
      		this.language = {
      			type: String,
      			choices: allowedLanguageCodes,
      			unique: false,
      			required: true
      		}

      		/**
      		 * Content written in the language assigned to this.language.
      		 */
      		this.content = {
      			type: String,
      			required: true,
      			unique: false
      		}
      	}

      }


      module.exports = { LocalizedContent };
diff --git a/documents/The_Basics.04___DB_Client_Basics.html b/documents/The_Basics.04___DB_Client_Basics.html
index a0e7322..eaa462c 100644
--- a/documents/The_Basics.04___DB_Client_Basics.html
+++ b/documents/The_Basics.04___DB_Client_Basics.html
@@ -1,4 +1,4 @@
-04 - DB Client Basics | SuperCamo - v1.0.5
      The database client is the main way that you should be interacting with the database in this package.
      
+04 - DB Client Basics | SuperCamo - v1.0.5
      The database client is the main way that you should be interacting with the database in this package.
      
 
      Instantiating a Database Client
      To work with data based on the documents that you've defined, you must create an instance of a database client.
      
 
      Essentially, we must tell each database client instance which documents (a.k.a models) they're allowed to use. We do this by specifying a key-value pair list of collections and their models.
      
 
      const SuperCamo = require("@bigfootds/supercamo");

      let exampleDb = await SuperCamo.connect(
      	"SomeDatabaseName", 
      	path.join(process.cwd(), "databases", "SomeDatabaseName"),
      	[
      		{name: "Users", model: User}, 
      		{name: "Admins", model: User}, 
      		{name: "Profiles", model: Profile},
      		{name: "Config", model: Settings}
      	]
      );
diff --git a/documents/The_Basics.html b/documents/The_Basics.html
index 0b4746b..bc63822 100644
--- a/documents/The_Basics.html
+++ b/documents/The_Basics.html
@@ -1,4 +1,4 @@
-The Basics | SuperCamo - v1.0.5
      This section introduces the fundamental concepts that this package relies on. There are only a few main components. In general, when using this package, you will want to:
      
+The Basics | SuperCamo - v1.0.5
      This section introduces the fundamental concepts that this package relies on. There are only a few main components. In general, when using this package, you will want to:
      
 
        
 
      1. Define your documents and subdocuments.
        2. 
 
      2. Create database client instances that use your defined documents and their subdocuments.
        3. 
diff --git a/documents/Tips___Tricks.html b/documents/Tips___Tricks.html
index 2f56131..d2641e3 100644
--- a/documents/Tips___Tricks.html
+++ b/documents/Tips___Tricks.html
@@ -1,4 +1,4 @@
-Tips & Tricks | SuperCamo - v1.0.5
        There are some cool things that you can do with this package!
        
+Tips & Tricks | SuperCamo - v1.0.5
        There are some cool things that you can do with this package!
        
 
        TypeScript's Improved Intellisense
        TypeScript can pick up more information from this package than regular JavaScript can. This isn't a huge deal, but it does help in some situations, such as when you're declaring the rules within a document.
        
 
        When your cursor is within a rule object, you can enter a keyboard shortcut to show all compatible values based on your cursor's position. In TypeScript, this will show all possible constraints that you can define in a document's rule. Like so:
        
 
        A screenshot of Visual Studio Code, showing an intellisense menu pop-up.
        
diff --git a/functions/Logging.SuperCamoLogger.html b/functions/Logging.SuperCamoLogger.html
index 86f579f..cef0201 100644
--- a/functions/Logging.SuperCamoLogger.html
+++ b/functions/Logging.SuperCamoLogger.html
@@ -1,4 +1,4 @@
-SuperCamoLogger | SuperCamo - v1.0.5
        Function SuperCamoLogger
        • SuperCamoLogger(message, caller?): void
        • Pass a string to this, and it'll automatically figure out which NodeJS util.DebugLogger to use.
          
+SuperCamoLogger | SuperCamo - v1.0.5
          Function SuperCamoLogger
          • SuperCamoLogger(message, caller?): void
          • Pass a string to this, and it'll automatically figure out which NodeJS util.DebugLogger to use.
            
 
            This is not a function that you should be using within your own project's code, but this is more for anyone who is contributing to SuperCamo development to use.
            
 
            If you're not a contributor, you may just wanna stick to the parent "Logging" page so you can see the NODE_DEBUG values that you can use to see this package's logger output instead.
            
 
            You would use this within the SuperCamo package's code in place of console.log statements. Refer to the example section below.
            
@@ -8,4 +8,4 @@
 
      
 
 
      Author
      BigfootDS
      
-
      Settings
      Member Visibility
      
+
      Settings
      Member Visibility
      
diff --git a/hierarchy.html b/hierarchy.html
index ebaf5d2..902df62 100644
--- a/hierarchy.html
+++ b/hierarchy.html
@@ -1 +1 @@
-SuperCamo - v1.0.5
      SuperCamo - v1.0.5
      Class Hierarchy
      Settings
      Member Visibility
      
+SuperCamo - v1.0.5
      SuperCamo - v1.0.5
      Class Hierarchy
      Settings
      Member Visibility
      
diff --git a/index.html b/index.html
index f052ea9..7e663cc 100644
--- a/index.html
+++ b/index.html
@@ -1,4 +1,4 @@
-SuperCamo - v1.0.5
      SuperCamo - v1.0.5
      SuperCamo
      SuperCamo is a Camo-inspired object data modeller (ODM) for NeDB, built specifically for BigfootDS' needs.
      
+SuperCamo - v1.0.5
      SuperCamo - v1.0.5
      SuperCamo
      SuperCamo is a Camo-inspired object data modeller (ODM) for NeDB, built specifically for BigfootDS' needs.
      
 
      This package was inspired by Scott Robinson's Camo ODM - but BigfootDS had some specific needs and an urge to try out TypeScript. We greatly appreciate what Camo is and does!
      
 
      The URLs
      
 
 
      Author
      BigfootDS
      
-
      data
      data: DocumentConstructorData
      Storage of the document data, used when making instances of document-based classes to create documents.
      
+
      data
      data: DocumentConstructorData
      Storage of the document data, used when making instances of document-based classes to create documents.
      
 
      eg. this.username would define the rules that the data must obey for the username property of a document, while the actual data for username should live in this.data.username.
      
 
      Author
      BigfootDS
      
-
      parentDatabaseName
      parentDatabaseName: null | string
      The name of the database that the data for this document instance has come from. Useful for checking if a database already has this document, from the document or generic functions.
      
+
      parentDatabaseName
      parentDatabaseName: null | string
      The name of the database that the data for this document instance has come from. Useful for checking if a database already has this document, from the document or generic functions.
      
 
      However, this will be null if the document instance was created without the involvement of a database query.
      
 
      Examples:
      No value:
      
 
      let newUser = await User.create({username:"alex"});
      console.log(newUser.parentDatabaseName); // null/undefined expected
@@ -26,4 +26,4 @@
 
      
 
 
      Author
      BigfootDS
      
-
      Settings
      Member Visibility
      On This Page
      Properties
      
+
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/interfaces/Interfaces.CollectionAccessor.html b/interfaces/Interfaces.CollectionAccessor.html
index dc36cd5..fb02201 100644
--- a/interfaces/Interfaces.CollectionAccessor.html
+++ b/interfaces/Interfaces.CollectionAccessor.html
@@ -1,13 +1,13 @@
-CollectionAccessor | SuperCamo - v1.0.5
      Interface CollectionAccessor
      interface CollectionAccessor { 
          datastore: Nedb<Record<string, any>>; 
          model: typeof NedbDocument; 
          name: string; 
          path: string; 
      }
      Implemented by
      Properties
      datastore
+CollectionAccessor | SuperCamo - v1.0.5
      Interface CollectionAccessor
      interface CollectionAccessor { 
          datastore: Nedb<Record<string, any>>; 
          model: typeof NedbDocument; 
          name: string; 
          path: string; 
      }
      Implemented by
      Properties
      datastore
 model
 name
 path
 
       Properties
      datastore
      datastore: Nedb<Record<string, any>>
      Reference to the NeDB Datastore object for this collection.
      
 
      Author
      BigfootDS
      
-
      model
      model: typeof NedbDocument
      Reference to the NedbDocument-inheriting class used to define the collection's data structure.
      
+
      model
      model: typeof NedbDocument
      Reference to the NedbDocument-inheriting class used to define the collection's data structure.
      
 
      Author
      BigfootDS
      
-
      name
      name: string
      Name of the collection.
      
+
      name
      name: string
      Name of the collection.
      
 
      Author
      BigfootDS
      
-
      path
      path: string
      Path to its ".db" NeDB file.
      
+
      path
      path: string
      Path to its ".db" NeDB file.
      
 
      Author
      BigfootDS
      
-
      Settings
      Member Visibility
      On This Page
      Properties
      
+
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/interfaces/Interfaces.CollectionsListEntry.html b/interfaces/Interfaces.CollectionsListEntry.html
index 943e3c4..69472e7 100644
--- a/interfaces/Interfaces.CollectionsListEntry.html
+++ b/interfaces/Interfaces.CollectionsListEntry.html
@@ -1,7 +1,7 @@
-CollectionsListEntry | SuperCamo - v1.0.5
      Interface CollectionsListEntry
      interface CollectionsListEntry { 
          model: typeof NedbDocument; 
          name: string; 
      }
      Implemented by
      Properties
      model
+CollectionsListEntry | SuperCamo - v1.0.5
      Interface CollectionsListEntry
      interface CollectionsListEntry { 
          model: typeof NedbDocument; 
          name: string; 
      }
      Implemented by
      Properties
      model
 name
 
       Properties
      model
      model: typeof NedbDocument
      Reference to the NedbDocument-inheriting class used to define the collection's data structure.
      
 
      Author
      BigfootDS
      
-
      name
      name: string
      Name of the collection.
      
+
      name
      name: string
      Name of the collection.
      
 
      Author
      BigfootDS
      
-
      Settings
      Member Visibility
      On This Page
      Properties
      
+
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/interfaces/Interfaces.DocumentBaseData.html b/interfaces/Interfaces.DocumentBaseData.html
index 219b599..3881f65 100644
--- a/interfaces/Interfaces.DocumentBaseData.html
+++ b/interfaces/Interfaces.DocumentBaseData.html
@@ -1 +1 @@
-DocumentBaseData | SuperCamo - v1.0.5
      Interface DocumentBaseData
      Hierarchy (view full)
      Indexable
      • [key: string]: any
      Settings
      Member Visibility
      
+DocumentBaseData | SuperCamo - v1.0.5
      Interface DocumentBaseData
      Hierarchy (view full)
      Indexable
      • [key: string]: any
      Settings
      Member Visibility
      
diff --git a/interfaces/Interfaces.DocumentConstructorData.html b/interfaces/Interfaces.DocumentConstructorData.html
index 5aba291..b24cabb 100644
--- a/interfaces/Interfaces.DocumentConstructorData.html
+++ b/interfaces/Interfaces.DocumentConstructorData.html
@@ -1,2 +1,2 @@
-DocumentConstructorData | SuperCamo - v1.0.5
      Interface DocumentConstructorData
      interface DocumentConstructorData { 
          _id?: string; 
      }
      Hierarchy (view full)
      Properties
      _id?
-
       Properties
      Optional_id
      _id?: string
      Settings
      Member Visibility
      On This Page
      Properties
      
+DocumentConstructorData | SuperCamo - v1.0.5
      Interface DocumentConstructorData
      interface DocumentConstructorData { 
          _id?: string; 
      }
      Hierarchy (view full)
      Properties
      _id?
+
       Properties
      Optional_id
      _id?: string
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/interfaces/Interfaces.DocumentKeyRule.html b/interfaces/Interfaces.DocumentKeyRule.html
index 82dd434..554d04a 100644
--- a/interfaces/Interfaces.DocumentKeyRule.html
+++ b/interfaces/Interfaces.DocumentKeyRule.html
@@ -1,4 +1,4 @@
-DocumentKeyRule | SuperCamo - v1.0.5
      Interface DocumentKeyRule
      interface DocumentKeyRule { 
          choices?: any[]; 
          collection?: string; 
          default?: any; 
          invalidateOnMinMaxError?: boolean; 
          match?: string | RegExp; 
          max?: number; 
          maxLength?: number; 
          min?: number; 
          minLength?: number; 
          padArrayValue?: any; 
          padStringValue?: string; 
          required?: boolean; 
          type: any; 
          unique?: boolean; 
          validate?: Function; 
      }
      Properties
      choices?
+DocumentKeyRule | SuperCamo - v1.0.5
      Interface DocumentKeyRule
      interface DocumentKeyRule { 
          choices?: any[]; 
          collection?: string; 
          default?: any; 
          invalidateOnMinMaxError?: boolean; 
          match?: string | RegExp; 
          max?: number; 
          maxLength?: number; 
          min?: number; 
          minLength?: number; 
          padArrayValue?: any; 
          padStringValue?: string; 
          required?: boolean; 
          type: any; 
          unique?: boolean; 
          validate?: Function; 
      }
      Properties
      choices?
 collection?
 default?
 invalidateOnMinMaxError?
@@ -15,41 +15,41 @@
 validate?
 
       Properties
      Optionalchoices
      choices?: any[]
      An array of data that should match the specified type, to restrict the possible values of this property.
      
 
      Author
      BigfootDS
      
-
      Optionalcollection
      collection?: string
      Used for properties that are references to other documents. The value of this should be the name of the collection that the referenced document lives in.
+
      Optionalcollection
      collection?: string
      Used for properties that are references to other documents. The value of this should be the name of the collection that the referenced document lives in.
 eg. collection: "Users", would be useful for refering to documents that live in a "Users" collection of a database.
 No, you cannot refer to collections that exist in separate database clients.
      
 
      Author
      BigfootDS
      
-
      Optionaldefault
      default?: any
      The default data of this property, to be used if no data is provided or if a soft-invalidation occurs.
      
+
      Optionaldefault
      default?: any
      The default data of this property, to be used if no data is provided or if a soft-invalidation occurs.
      
 
      Author
      BigfootDS
      
-
      OptionalinvalidateOnMinMaxError
      invalidateOnMinMaxError?: boolean
      Determines whether not an invalid value for min, max, minLength, and maxLength properties will throw an error or just roll-over and allow the value to exist.
+
      OptionalinvalidateOnMinMaxError
      invalidateOnMinMaxError?: boolean
      Determines whether not an invalid value for min, max, minLength, and maxLength properties will throw an error or just roll-over and allow the value to exist.
 Depending on the property, it may get replaced with a default or min or max value if this is set to false.
      
 
      Author
      BigfootDS
      
-
      Optionalmatch
      match?: string | RegExp
      The regex expression that will be run against this property's data value. If the regex doesn't match, validation fails.
      
+
      Optionalmatch
      match?: string | RegExp
      The regex expression that will be run against this property's data value. If the regex doesn't match, validation fails.
      
 
      Author
      BigfootDS
      
-
      Optionalmax
      max?: number
      The highest value that this property can have for its data value.
+
      Optionalmax
      max?: number
      The highest value that this property can have for its data value.
 For properties that are numbers.
      
 
      Author
      BigfootDS
      
-
      OptionalmaxLength
      maxLength?: number
      The highest length that this property can have for its data value.
+
      OptionalmaxLength
      maxLength?: number
      The highest length that this property can have for its data value.
 For properties that are strings or arrays.
      
 
      Author
      BigfootDS
      
-
      Optionalmin
      min?: number
      The lowest value that this property can have for its data value.
+
      Optionalmin
      min?: number
      The lowest value that this property can have for its data value.
 For properties that are numbers.
      
 
      Author
      BigfootDS
      
-
      OptionalminLength
      minLength?: number
      The shortest length that this property can have for its data value.
+
      OptionalminLength
      minLength?: number
      The shortest length that this property can have for its data value.
 For properties that are strings or arrays.
      
 
      Author
      BigfootDS
      
-
      OptionalpadArrayValue
      padArrayValue?: any
      If an array data value's length is too short, this is the value that will be used to pad the array until it meets the minLength property.
      
+
      OptionalpadArrayValue
      padArrayValue?: any
      If an array data value's length is too short, this is the value that will be used to pad the array until it meets the minLength property.
      
 
      Author
      BigfootDS
      
-
      OptionalpadStringValue
      padStringValue?: string
      If a string data value is too short, this is the value that will be used to pad the data until it meets the minLength property.
      
+
      OptionalpadStringValue
      padStringValue?: string
      If a string data value is too short, this is the value that will be used to pad the data until it meets the minLength property.
      
 
      Author
      BigfootDS
      
-
      Optionalrequired
      required?: boolean
      Whether or not a property defined in the document's rules object must have a value in its data.
      
+
      Optionalrequired
      required?: boolean
      Whether or not a property defined in the document's rules object must have a value in its data.
      
 
      Author
      BigfootDS
      
-
      type
      type: any
      A JavaScript class or type.
+
      type
      type: any
      A JavaScript class or type.
 This should be on every document key rule object, it is required.
 Various other constraints depend on the type!
      
 
      Author
      BigfootDS
      
-
      Optionalunique
      unique?: boolean
      Whether or not the data value for this property should be unique within the database. This sets up a NeDB index, so it's not immediately checked at a SuperCamo level - but NeDB immediately enforces it.
      
+
      Optionalunique
      unique?: boolean
      Whether or not the data value for this property should be unique within the database. This sets up a NeDB index, so it's not immediately checked at a SuperCamo level - but NeDB immediately enforces it.
      
 
      Author
      BigfootDS
      
-
      Optionalvalidate
      validate?: Function
      A custom validate function that runs alongside any other constraints. The function must receive one parameter, which the document will pass in automatically - the parameter is the document's data for this property.
      
+
      Optionalvalidate
      validate?: Function
      A custom validate function that runs alongside any other constraints. The function must receive one parameter, which the document will pass in automatically - the parameter is the document's data for this property.
      
 
      Author
      BigfootDS
      
-
      Settings
      Member Visibility
      On This Page
      Properties
      
+
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/interfaces/Interfaces.DocumentObjectData.html b/interfaces/Interfaces.DocumentObjectData.html
index e320a71..ad3bce3 100644
--- a/interfaces/Interfaces.DocumentObjectData.html
+++ b/interfaces/Interfaces.DocumentObjectData.html
@@ -1,2 +1,2 @@
-DocumentObjectData | SuperCamo - v1.0.5
      Interface DocumentObjectData
      interface DocumentObjectData { 
          _id: string; 
      }
      Hierarchy (view full)
      Properties
      _id
-
       Properties
      _id
      _id: string
      Settings
      Member Visibility
      On This Page
      Properties
      
+DocumentObjectData | SuperCamo - v1.0.5
      Interface DocumentObjectData
      interface DocumentObjectData { 
          _id: string; 
      }
      Hierarchy (view full)
      Properties
      _id
+
       Properties
      _id
      _id: string
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/interfaces/Interfaces.NedbClientEntry.html b/interfaces/Interfaces.NedbClientEntry.html
index 50ab392..92e5eb6 100644
--- a/interfaces/Interfaces.NedbClientEntry.html
+++ b/interfaces/Interfaces.NedbClientEntry.html
@@ -1,16 +1,16 @@
-NedbClientEntry | SuperCamo - v1.0.5
      Interface NedbClientEntry
      interface NedbClientEntry { 
          collections: CollectionAccessor[]; 
          documents: typeof NedbDocument[]; 
          embeddedDocuments: typeof NedbEmbeddedDocument[]; 
          name: string; 
          path: string; 
      }
      Implemented by
      Properties
      collections
+NedbClientEntry | SuperCamo - v1.0.5
      Interface NedbClientEntry
      interface NedbClientEntry { 
          collections: CollectionAccessor[]; 
          documents: typeof NedbDocument[]; 
          embeddedDocuments: typeof NedbEmbeddedDocument[]; 
          name: string; 
          path: string; 
      }
      Implemented by
      Properties
      collections
 documents
 embeddedDocuments
 name
 path
 
       Properties
      collections
      collections: CollectionAccessor[]
      Array of collections used by this NeDB client. This is essentially where you track what models and collections are used in this particular database.
      
 
      Author
      BigfootDS
      
-
      documents
      documents: typeof NedbDocument[]
      Array of documents used by the collections within this NeDB client. This should be a smaller array than the collections, since multiple collections could be using the same document.
      
+
      documents
      documents: typeof NedbDocument[]
      Array of documents used by the collections within this NeDB client. This should be a smaller array than the collections, since multiple collections could be using the same document.
      
 
      Author
      BigfootDS
      
-
      embeddedDocuments
      embeddedDocuments: typeof NedbEmbeddedDocument[]
      Array of subdocuments or embedded documents used by the documents within the collections of this NeDB client.
      
+
      embeddedDocuments
      embeddedDocuments: typeof NedbEmbeddedDocument[]
      Array of subdocuments or embedded documents used by the documents within the collections of this NeDB client.
      
 
      Author
      BigfootDS
      
-
      name
      name: string
      Human-friendly name to identify the database when an app using SuperCamo is using multiple NeDB database connections simultaneously.
      
+
      name
      name: string
      Human-friendly name to identify the database when an app using SuperCamo is using multiple NeDB database connections simultaneously.
      
 
      Author
      BigfootDS
      
-
      path
      path: string
      The absolute file path to the folder that represents this NeDB client. Its collections are individual NeDB datastore files contained within this folder.
      
+
      path
      path: string
      The absolute file path to the folder that represents this NeDB client. Its collections are individual NeDB datastore files contained within this folder.
      
 
      Author
      BigfootDS
      
-
      Settings
      Member Visibility
      On This Page
      Properties
      
+
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/interfaces/Interfaces.findManyDocumentsOptions.html b/interfaces/Interfaces.findManyDocumentsOptions.html
index cd1a8dc..24b015e 100644
--- a/interfaces/Interfaces.findManyDocumentsOptions.html
+++ b/interfaces/Interfaces.findManyDocumentsOptions.html
@@ -1,6 +1,6 @@
-findManyDocumentsOptions | SuperCamo - v1.0.5
      Interface findManyDocumentsOptions
      Configuration object for methods that find many documents at once.
      
+findManyDocumentsOptions | SuperCamo - v1.0.5
      Interface findManyDocumentsOptions
      Configuration object for methods that find many documents at once.
      
 
      Author
      BigfootDS
      
-
      interface findManyDocumentsOptions { 
          limit: number; 
      }
      Properties
      limit
+
      interface findManyDocumentsOptions { 
          limit: number; 
      }
      Properties
      limit
 
       Properties
      limit
      limit: number
      A number to limit how many documents should be returned during a findMany operation.
      
 
      Author
      BigfootDS
      
-
      Settings
      Member Visibility
      On This Page
      Properties
      
+
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/interfaces/Interfaces.findManyObjectsOptions.html b/interfaces/Interfaces.findManyObjectsOptions.html
index b7c048a..9a0ed27 100644
--- a/interfaces/Interfaces.findManyObjectsOptions.html
+++ b/interfaces/Interfaces.findManyObjectsOptions.html
@@ -1,10 +1,10 @@
-findManyObjectsOptions | SuperCamo - v1.0.5
      Interface findManyObjectsOptions
      Configuration object for methods that find many documents as objects at once.
      
+findManyObjectsOptions | SuperCamo - v1.0.5
      Interface findManyObjectsOptions
      Configuration object for methods that find many documents as objects at once.
      
 
      Author
      BigfootDS
      
-
      interface findManyObjectsOptions { 
          limit: number; 
          projection: object; 
      }
      Properties
      limit
+
      interface findManyObjectsOptions { 
          limit: number; 
          projection: object; 
      }
      Properties
      limit
 projection
 
       Properties
      limit
      limit: number
      A number to limit how many documents should be returned during a findMany operation.
      
 
      Author
      BigfootDS
      
-
      projection
      projection: object
      A NeDB projection object. This is passed along as-is to NeDB, so please refer to their documentation about projections.
      
+
      projection
      projection: object
      A NeDB projection object. This is passed along as-is to NeDB, so please refer to their documentation about projections.
      
 
      https://github.com/louischatriot/nedb?tab=readme-ov-file#projections
      
 
      Author
      BigfootDS
      
-
      Settings
      Member Visibility
      On This Page
      Properties
      
+
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/interfaces/Interfaces.findOneObjectOptions.html b/interfaces/Interfaces.findOneObjectOptions.html
index 027ba92..7db9259 100644
--- a/interfaces/Interfaces.findOneObjectOptions.html
+++ b/interfaces/Interfaces.findOneObjectOptions.html
@@ -1,5 +1,5 @@
-findOneObjectOptions | SuperCamo - v1.0.5
      Interface findOneObjectOptions
      interface findOneObjectOptions { 
          projection: object; 
      }
      Properties
      projection
+findOneObjectOptions | SuperCamo - v1.0.5
      Interface findOneObjectOptions
      interface findOneObjectOptions { 
          projection: object; 
      }
      Properties
      projection
 
       Properties
      projection
      projection: object
      A NeDB projection object. This is passed along as-is to NeDB, so please refer to their documentation about projections.
      
 
      https://github.com/louischatriot/nedb?tab=readme-ov-file#projections
      
 
      Author
      BigfootDS
      
-
      Settings
      Member Visibility
      On This Page
      Properties
      
+
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/interfaces/Interfaces.updateManyOptions.html b/interfaces/Interfaces.updateManyOptions.html
index a2d49fa..cfa3b88 100644
--- a/interfaces/Interfaces.updateManyOptions.html
+++ b/interfaces/Interfaces.updateManyOptions.html
@@ -1,11 +1,11 @@
-updateManyOptions | SuperCamo - v1.0.5
      Interface updateManyOptions
      Configuration object for methods that update many documents at once.
      
+updateManyOptions | SuperCamo - v1.0.5
      Interface updateManyOptions
      Configuration object for methods that update many documents at once.
      
 
      Author
      BigfootDS
      
-
      interface updateManyOptions { 
          limit: number; 
          upsert: boolean; 
      }
      Properties
      limit
+
      interface updateManyOptions { 
          limit: number; 
          upsert: boolean; 
      }
      Properties
      limit
 upsert
 
       Properties
      limit
      limit: number
      A number to limit how many documents should be updated during an updateMany operation.
      
 
      Author
      BigfootDS
      
-
      upsert
      upsert: boolean
      During the requested update operation, if no document already exists that matches the query, this controls whether or not a new document should be created.
+
      upsert
      upsert: boolean
      During the requested update operation, if no document already exists that matches the query, this controls whether or not a new document should be created.
 If true: a new document is created.
 If false: no new document is created.
      
 
      Author
      BigfootDS
      
-
      Settings
      Member Visibility
      On This Page
      Properties
      
+
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/interfaces/Interfaces.updateOptions.html b/interfaces/Interfaces.updateOptions.html
index 4b9ebce..6f1cdd8 100644
--- a/interfaces/Interfaces.updateOptions.html
+++ b/interfaces/Interfaces.updateOptions.html
@@ -1,8 +1,8 @@
-updateOptions | SuperCamo - v1.0.5
      Interface updateOptions
      Configuration object for methods that update a singular document at a time.
      
+updateOptions | SuperCamo - v1.0.5
      Interface updateOptions
      Configuration object for methods that update a singular document at a time.
      
 
      Author
      BigfootDS
      
-
      interface updateOptions { 
          upsert: boolean; 
      }
      Properties
      upsert
+
      interface updateOptions { 
          upsert: boolean; 
      }
      Properties
      upsert
 
       Properties
      upsert
      upsert: boolean
      During the requested update operation, if no document already exists that matches the query, this controls whether or not a new document should be created.
 If true: a new document is created.
 If false: no new document is created.
      
 
      Author
      BigfootDS
      
-
      Settings
      Member Visibility
      On This Page
      Properties
      
+
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/interfaces/Package_Exports.SuperCamoInterfaces.html b/interfaces/Package_Exports.SuperCamoInterfaces.html
deleted file mode 100644
index 1290bc8..0000000
--- a/interfaces/Package_Exports.SuperCamoInterfaces.html
+++ /dev/null
@@ -1,10 +0,0 @@
-SuperCamoInterfaces | SuperCamo - v1.0.5
      Interface SuperCamoInterfaces
      interface SuperCamoInterfaces { 
          BaseDocument: BaseDocument; 
          CollectionAccessor: CollectionAccessor; 
          CollectionsListEntry: CollectionsListEntry; 
          DocumentBaseData: DocumentBaseData; 
          DocumentConstructorData: DocumentConstructorData; 
          DocumentKeyRule: DocumentKeyRule; 
          DocumentObjectData: DocumentObjectData; 
          NedbClientEntry: NedbClientEntry; 
          QueryOptions: { 
              findManyDocumentsOptions: findManyDocumentsOptions; 
              findManyObjectsOptions: findManyObjectsOptions; 
              findOneObjectOptions: findOneObjectOptions; 
              updateManyOptions: updateManyOptions; 
              updateOptions: updateOptions; 
          }; 
      }
      Properties
      BaseDocument
-CollectionAccessor
-CollectionsListEntry
-DocumentBaseData
-DocumentConstructorData
-DocumentKeyRule
-DocumentObjectData
-NedbClientEntry
-QueryOptions
-
       Properties
      BaseDocument
      BaseDocument: BaseDocument
      CollectionAccessor
      CollectionAccessor: CollectionAccessor
      CollectionsListEntry
      CollectionsListEntry: CollectionsListEntry
      DocumentBaseData
      DocumentBaseData: DocumentBaseData
      DocumentConstructorData
      DocumentConstructorData: DocumentConstructorData
      DocumentKeyRule
      DocumentKeyRule: DocumentKeyRule
      DocumentObjectData
      DocumentObjectData: DocumentObjectData
      NedbClientEntry
      NedbClientEntry: NedbClientEntry
      QueryOptions
      QueryOptions: { 
          findManyDocumentsOptions: findManyDocumentsOptions; 
          findManyObjectsOptions: findManyObjectsOptions; 
          findOneObjectOptions: findOneObjectOptions; 
          updateManyOptions: updateManyOptions; 
          updateOptions: updateOptions; 
      }
      Settings
      Member Visibility
      On This Page
      Properties
      
diff --git a/modules/Classes.html b/modules/Classes.html
index e8d2074..8f8fd92 100644
--- a/modules/Classes.html
+++ b/modules/Classes.html
@@ -1,4 +1,4 @@
-Classes | SuperCamo - v1.0.5
      Module Classes
      Remarks
      These classes will be the most-common thing you'll interact with when using this package.
      
+Classes | SuperCamo - v1.0.5
      Module Classes
      Remarks
      These classes will be the most-common thing you'll interact with when using this package.
      
 
      Typically, you'd be using the SuperCamo singleton class for its static methods and defining your own document models by inheriting from NedbDocument and NedbEmbeddedDocument classes.
      
 
      Example
      NodeJS CommonJS import:
      
 
      const {SuperCamo} = require("@bigfootds/supercamo");
      SuperCamo.clientConnect(/* params go here */);
@@ -11,7 +11,7 @@ 
      Exampleimport {SuperCamo} from "@bigfootds/supercamo";
      SuperCamo.clientConnect(/* params go here */);
 
      
 
-
      Index
      Classes
      CollectionAccessor
+
      Index
      Classes
      CollectionAccessor
 CollectionListEntry
 NedbBaseDocument
 NedbClient
diff --git a/modules/Error_Classes.html b/modules/Error_Classes.html
index ed3caa8..de4bf1e 100644
--- a/modules/Error_Classes.html
+++ b/modules/Error_Classes.html
@@ -1,4 +1,4 @@
-Error Classes | SuperCamo - v1.0.5
      Module Error Classes
      Index
      Classes
      CollectionAccessError
+Error Classes | SuperCamo - v1.0.5
      Module Error Classes
      Index
      Classes
      CollectionAccessError
 DeleteFailure
 PostDeleteFailure
 PostSaveFailure
diff --git a/modules/Interfaces.html b/modules/Interfaces.html
index b9b2f85..50c920e 100644
--- a/modules/Interfaces.html
+++ b/modules/Interfaces.html
@@ -1,6 +1,6 @@
-Interfaces | SuperCamo - v1.0.5
      Module InterfacesInterface
      The core properties of any type of document used in SuperCamo.
      
+Interfaces | SuperCamo - v1.0.5
      Module InterfacesInterface
      The core properties of any type of document used in SuperCamo.
      
 
      Author
      BigfootDS
      
-
      Index
      Interfaces
      BaseDocument
+
      Index
      Interfaces
      BaseDocument
 CollectionAccessor
 CollectionsListEntry
 DocumentBaseData
diff --git a/modules/Logging.html b/modules/Logging.html
index 35efa34..f967ad3 100644
--- a/modules/Logging.html
+++ b/modules/Logging.html
@@ -1,4 +1,4 @@
-Logging | SuperCamo - v1.0.5
      Module Logging
      Configured logging system for the SuperCamo package.
      
+Logging | SuperCamo - v1.0.5
      Module Logging
      Configured logging system for the SuperCamo package.
      
 
      This is not something for users of the SuperCamo package to directly use. Instead, this is something impacted by usage of the NODE_DEBUG environment variable.
      
 
      For example, if you want logging from multiple packages, including SuperCamo, you may want to set NODE_DEBUG to be or include "verbose". This would enable multiple packages to log.
 But if you only want SuperCamo to log, and not any other packages, you may want to set NODE_DEBUG to be or include "supercamo".
      
@@ -13,5 +13,5 @@ 
      Copy

    Author

    BigfootDS

    -

    Index

    Functions

    SuperCamoLogger +

    Index

    Functions

    SuperCamoLogger

    Settings

    Member Visibility
    diff --git a/modules/Package_Exports.html b/modules/Package_Exports.html index 8daf793..a739f96 100644 --- a/modules/Package_Exports.html +++ b/modules/Package_Exports.html @@ -1,4 +1,4 @@ -Package Exports | SuperCamo - v1.0.5

    Module Package Exports

    This is the content that you can import in your own code.

    +Package Exports | SuperCamo - v1.0.5

    Module Package Exports

    This is the content that you can import in your own code.

    Example

    NodeJS CommonJS import:

    const {NedbClient, SuperCamo} = require("@bigfootds/supercamo");
    @@ -10,12 +10,24 @@ 
    import {SuperCamo} from "@bigfootds/supercamo";
    -

    References

    CollectionAccessor +

    References

    BaseDocument +CollectionAccessor +CollectionAccessorData CollectionListEntry +CollectionsListEntry +DocumentBaseData +DocumentConstructorData +DocumentKeyRule +DocumentObjectData +findManyDocumentsOptions +findManyObjectsOptions +findOneObjectOptions NedbBaseDocumentErrors NedbClient +NedbClientEntry NedbDocument NedbEmbeddedDocument SuperCamo -

    Interfaces

    SuperCamoInterfaces -

    References

    CollectionAccessor

    Re-exports CollectionAccessor

    CollectionListEntry

    Re-exports CollectionListEntry

    NedbBaseDocumentErrors

    Renames and re-exports Error Classes

    NedbClient

    Re-exports NedbClient

    NedbDocument

    Re-exports NedbDocument

    NedbEmbeddedDocument

    Re-exports NedbEmbeddedDocument

    SuperCamo

    Re-exports SuperCamo

    Settings

    Member Visibility

    On This Page

    References
    +updateManyOptions +updateOptions +

    References

    BaseDocument

    Re-exports BaseDocument

    CollectionAccessor

    Re-exports CollectionAccessor

    CollectionAccessorData

    Renames and re-exports CollectionAccessor

    CollectionListEntry

    Re-exports CollectionListEntry

    CollectionsListEntry

    Re-exports CollectionsListEntry

    DocumentBaseData

    Re-exports DocumentBaseData

    DocumentConstructorData

    Re-exports DocumentConstructorData

    DocumentKeyRule

    Re-exports DocumentKeyRule

    DocumentObjectData

    Re-exports DocumentObjectData

    findManyDocumentsOptions

    Re-exports findManyDocumentsOptions

    findManyObjectsOptions

    Re-exports findManyObjectsOptions

    findOneObjectOptions

    Re-exports findOneObjectOptions

    NedbBaseDocumentErrors

    Renames and re-exports Error Classes

    NedbClient

    Re-exports NedbClient

    NedbClientEntry

    Re-exports NedbClientEntry

    NedbDocument

    Re-exports NedbDocument

    NedbEmbeddedDocument

    Re-exports NedbEmbeddedDocument

    SuperCamo

    Re-exports SuperCamo

    updateManyOptions

    Re-exports updateManyOptions

    updateOptions

    Re-exports updateOptions

    Settings

    Member Visibility

    On This Page

    References
    diff --git a/sitemap.xml b/sitemap.xml index 1f86089..9390f70 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,214 +2,210 @@ https://bigfootds.github.io/supercamo/index.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/hierarchy.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/documents/Quick_Start.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/documents/The_Basics.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/documents/The_Basics.00___Understanding_This_Package.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/documents/The_Basics.01___The_SuperCamo_Singleton.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/documents/The_Basics.02___Document_Basics.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/documents/The_Basics.03___Embedded_Document_Basics.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/documents/The_Basics.04___DB_Client_Basics.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/documents/Tips___Tricks.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/modules/Classes.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Classes.CollectionAccessor.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Classes.CollectionListEntry.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Classes.NedbBaseDocument.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Classes.NedbClient.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Classes.NedbDocument.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Classes.NedbEmbeddedDocument.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Classes.SuperCamo.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/modules/Error_Classes.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.CollectionAccessError.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.DeleteFailure.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.PostDeleteFailure.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.PostSaveFailure.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.PostValidationFailure.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.PreDeleteFailure.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.PreSaveFailure.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.PreValidationFailure.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.SaveFailure.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.ValidationFailure.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.ValidationFailureMinMaxError.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.ValidationFailureMissingValueForProperty.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.ValidationFailureMissingValueForReferencedDoc.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.ValidationFailureReferenceWithoutDatabase.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.ValidationFailureUnexpectedProperty.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/classes/Error_Classes.ValidationFailureValueNotInChoices.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/modules/Interfaces.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.BaseDocument.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.CollectionAccessor.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.CollectionsListEntry.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.DocumentBaseData.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.DocumentConstructorData.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.DocumentKeyRule.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.DocumentObjectData.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.findManyDocumentsOptions.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.findManyObjectsOptions.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.findOneObjectOptions.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.NedbClientEntry.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.updateManyOptions.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/interfaces/Interfaces.updateOptions.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/modules/Logging.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/functions/Logging.SuperCamoLogger.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z https://bigfootds.github.io/supercamo/modules/Package_Exports.html - 2024-10-19T06:55:57.953Z - - - https://bigfootds.github.io/supercamo/interfaces/Package_Exports.SuperCamoInterfaces.html - 2024-10-19T06:55:57.953Z + 2024-10-19T07:11:43.082Z