Update gh-pages to output generated at 0158b6c

BigfootDS · Sep 29, 2024 · ab40676 · ab40676
1 parent f33084a
commit ab40676
Show file tree

Hide file tree

Showing 53 changed files with 268 additions and 268 deletions.
diff --git a/classes/Classes.CollectionAccessor.html b/classes/Classes.CollectionAccessor.html
diff --git a/classes/Classes.CollectionListEntry.html b/classes/Classes.CollectionListEntry.html
diff --git a/classes/Classes.NedbBaseDocument.html b/classes/Classes.NedbBaseDocument.html
diff --git a/classes/Classes.NedbClient.html b/classes/Classes.NedbClient.html
diff --git a/classes/Classes.NedbDocument.html b/classes/Classes.NedbDocument.html
diff --git a/classes/Classes.NedbEmbeddedDocument.html b/classes/Classes.NedbEmbeddedDocument.html
diff --git a/classes/Classes.SuperCamo.html b/classes/Classes.SuperCamo.html
diff --git a/classes/Error_Classes.CollectionAccessError.html b/classes/Error_Classes.CollectionAccessError.html
diff --git a/classes/Error_Classes.DeleteFailure.html b/classes/Error_Classes.DeleteFailure.html
diff --git a/classes/Error_Classes.PostDeleteFailure.html b/classes/Error_Classes.PostDeleteFailure.html
diff --git a/classes/Error_Classes.PostSaveFailure.html b/classes/Error_Classes.PostSaveFailure.html
diff --git a/classes/Error_Classes.PostValidationFailure.html b/classes/Error_Classes.PostValidationFailure.html
diff --git a/classes/Error_Classes.PreDeleteFailure.html b/classes/Error_Classes.PreDeleteFailure.html
diff --git a/classes/Error_Classes.PreSaveFailure.html b/classes/Error_Classes.PreSaveFailure.html
diff --git a/classes/Error_Classes.PreValidationFailure.html b/classes/Error_Classes.PreValidationFailure.html
diff --git a/classes/Error_Classes.SaveFailure.html b/classes/Error_Classes.SaveFailure.html
diff --git a/classes/Error_Classes.ValidationFailure.html b/classes/Error_Classes.ValidationFailure.html
diff --git a/classes/Error_Classes.ValidationFailureMinMaxError.html b/classes/Error_Classes.ValidationFailureMinMaxError.html
diff --git a/classes/Error_Classes.ValidationFailureMissingValueForProperty.html b/classes/Error_Classes.ValidationFailureMissingValueForProperty.html
diff --git a/classes/Error_Classes.ValidationFailureMissingValueForReferencedDoc.html b/classes/Error_Classes.ValidationFailureMissingValueForReferencedDoc.html
diff --git a/classes/Error_Classes.ValidationFailureReferenceWithoutDatabase.html b/classes/Error_Classes.ValidationFailureReferenceWithoutDatabase.html
diff --git a/classes/Error_Classes.ValidationFailureUnexpectedProperty.html b/classes/Error_Classes.ValidationFailureUnexpectedProperty.html
diff --git a/classes/Error_Classes.ValidationFailureValueNotInChoices.html b/classes/Error_Classes.ValidationFailureValueNotInChoices.html
diff --git a/documents/Quick_Start.html b/documents/Quick_Start.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Quick Start | SuperCamo - v1.0.4</title><meta name="description" content="Documentation for SuperCamo"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1727586486311"/><link rel="stylesheet" href="../assets/highlight.css?cache=1727586486311"/><script defer src="../assets/main.js?cache=1727586486311"></script><script async src="../assets/icons.js?cache=1727586486311" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1727586486311" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1727586486311" id="tsd-nav-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/BigfootDS/supercamo">GitHub Repository</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">SuperCamo - v1.0.4</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">SuperCamo</a></li><li><a href="Quick_Start.html">Quick Start</a></li></ul></div><div class="tsd-panel tsd-typography"><p>This is a NoSQL &quot;ODM&quot; 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.</p>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Quick Start | SuperCamo - v1.0.4</title><meta name="description" content="Documentation for SuperCamo"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1727586564930"/><link rel="stylesheet" href="../assets/highlight.css?cache=1727586564930"/><script defer src="../assets/main.js?cache=1727586564930"></script><script async src="../assets/icons.js?cache=1727586564930" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1727586564930" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1727586564930" id="tsd-nav-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/BigfootDS/supercamo">GitHub Repository</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">SuperCamo - v1.0.4</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">SuperCamo</a></li><li><a href="Quick_Start.html">Quick Start</a></li></ul></div><div class="tsd-panel tsd-typography"><p>This is a NoSQL &quot;ODM&quot; 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.</p>
 <p>It's like how MongooseJS is for MongoDB - SuperCamo is for NeDB.</p>
 <a id="md:installation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Installation<a href="#md:installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Install this package as a production dependency using this command:</p>
 <pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@bigfootds/supercamo</span>

diff --git a/documents/The_Basics.00___Understanding_This_Package.html b/documents/The_Basics.00___Understanding_This_Package.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>00 - Understanding This Package | SuperCamo - v1.0.4</title><meta name="description" content="Documentation for SuperCamo"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1727586486311"/><link rel="stylesheet" href="../assets/highlight.css?cache=1727586486311"/><script defer src="../assets/main.js?cache=1727586486311"></script><script async src="../assets/icons.js?cache=1727586486311" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1727586486311" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1727586486311" id="tsd-nav-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/BigfootDS/supercamo">GitHub Repository</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">SuperCamo - v1.0.4</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">SuperCamo</a></li><li><a href="The_Basics.html">The Basics</a></li><li><a href="The_Basics.00___Understanding_This_Package.html">00 - Understanding This Package</a></li></ul></div><div class="tsd-panel tsd-typography"><p>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.</p>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>00 - Understanding This Package | SuperCamo - v1.0.4</title><meta name="description" content="Documentation for SuperCamo"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1727586564930"/><link rel="stylesheet" href="../assets/highlight.css?cache=1727586564930"/><script defer src="../assets/main.js?cache=1727586564930"></script><script async src="../assets/icons.js?cache=1727586564930" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1727586564930" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1727586564930" id="tsd-nav-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/BigfootDS/supercamo">GitHub Repository</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">SuperCamo - v1.0.4</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">SuperCamo</a></li><li><a href="The_Basics.html">The Basics</a></li><li><a href="The_Basics.00___Understanding_This_Package.html">00 - Understanding This Package</a></li></ul></div><div class="tsd-panel tsd-typography"><p>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.</p>
 <p>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.</p>
 <p>There are a lot of moving pieces in this system. In a nutshell:</p>
 <a id="md:the-supercamo-singleton" class="tsd-anchor"></a><h2 class="tsd-anchor-link">The SuperCamo singleton<a href="#md:the-supercamo-singleton" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>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.</p>

diff --git a/documents/The_Basics.01___The_SuperCamo_Singleton.html b/documents/The_Basics.01___The_SuperCamo_Singleton.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>01 - The SuperCamo Singleton | SuperCamo - v1.0.4</title><meta name="description" content="Documentation for SuperCamo"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1727586486311"/><link rel="stylesheet" href="../assets/highlight.css?cache=1727586486311"/><script defer src="../assets/main.js?cache=1727586486311"></script><script async src="../assets/icons.js?cache=1727586486311" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1727586486311" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1727586486311" id="tsd-nav-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/BigfootDS/supercamo">GitHub Repository</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">SuperCamo - v1.0.4</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">SuperCamo</a></li><li><a href="The_Basics.html">The Basics</a></li><li><a href="The_Basics.01___The_SuperCamo_Singleton.html">01 - The SuperCamo Singleton</a></li></ul></div><div class="tsd-panel tsd-typography"><p>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.</p>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>01 - The SuperCamo Singleton | SuperCamo - v1.0.4</title><meta name="description" content="Documentation for SuperCamo"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1727586564930"/><link rel="stylesheet" href="../assets/highlight.css?cache=1727586564930"/><script defer src="../assets/main.js?cache=1727586564930"></script><script async src="../assets/icons.js?cache=1727586564930" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1727586564930" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1727586564930" id="tsd-nav-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/BigfootDS/supercamo">GitHub Repository</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">SuperCamo - v1.0.4</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">SuperCamo</a></li><li><a href="The_Basics.html">The Basics</a></li><li><a href="The_Basics.01___The_SuperCamo_Singleton.html">01 - The SuperCamo Singleton</a></li></ul></div><div class="tsd-panel tsd-typography"><p>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.</p>
 <p>Essentially, you should connect to a database via the SuperCamo singleton. The <code>SuperCamo.clientConnect()</code> 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.</p>
 <p>This means that when your app runs, you should follow this process:</p>
 <ol>