Merge pull request #62 from ExWeiv/dev

Docs and Types Updated
ExWeiv · May 15, 2024 · 6ed8526 · 6ed8526
2 parents 3d2cefe + 26edcb8
commit 6ed8526
Show file tree

Hide file tree

Showing 97 changed files with 271 additions and 341 deletions.
diff --git a/app/lib/app.js b/app/lib/app.js
diff --git a/app/package-lock.json b/app/package-lock.json
diff --git a/app/package.json b/app/package.json
@@ -1,12 +1,13 @@
 {
   "name": "@exweiv/weiv-data",
-  "version": "3.1.0.beta-1",
+  "version": "3.1.0-beta4",
   "description": "Custom API Library for Wix sites to connect MongoDB. Designed to easily switch from wix-data APIs.",
   "main": "./lib/index.js",
   "files": [
     "lib",
     "src",
-    "tsconfig.json"
+    "tsconfig.json",
+    "weivdata.d.ts"
   ],
   "types": "weivdata.d.ts",
   "scripts": {

diff --git a/app/weivdata.d.ts b/app/weivdata.d.ts
@@ -985,7 +985,7 @@ declare module '@exweiv/weiv-data' {
      * @param options An object containing options to use when processing this operation.
      * @returns Fulfilled - Found item. Rejected - The error caused the rejection.
      */
-    function findOne(collectionId: CollectionID, propertyName: string, value: any, options?: WeivDataOptions): Promise<Item | undefined>;
+    function findOne(collectionId: CollectionID, propertyName: string, value: any, options?: WeivDataOptionsCache): Promise<Item | undefined>;
 
     /**
      * @description
@@ -1004,7 +1004,7 @@ declare module '@exweiv/weiv-data' {
      * @param options An object containing options to use when processing this operation.
      * @returns Fulfilled - The retrieved item or null if not found. Rejected - The error that caused the rejection.
      */
-    function get(collectionId: CollectionID, itemId: ItemID, options?: WeivDataOptions): Promise<Item | null>;
+    function get(collectionId: CollectionID, itemId: ItemID, options?: WeivDataOptionsCache): Promise<Item | null>;
 
     /**
      * @description
@@ -1108,7 +1108,7 @@ declare module '@exweiv/weiv-data' {
         propertyName: string,
         referringItem: ItemID | Item,
         referencedItem: Item | Item[] | ItemID | ItemID[],
-        options?: WeivDataOptions): Promise<boolean>;
+        options?: WeivDataOptionsCache): Promise<boolean>;
 
     /**
      * @description

diff --git a/docs/functions/Hooks.afterCount.html b/docs/functions/Hooks.afterCount.html
@@ -3,10 +3,10 @@
 </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">context</span>: <a href="../types/Hooks.HookContext.html" class="tsd-signature-type tsd-kind-type-alias">HookContext</a></span><div class="tsd-comment tsd-typography"><p>Contextual information about the hook.</p>
 </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h4><p>The count to return to <code>count()</code> instead of the original count. Returning a rejected promise will not block the operation, but will return a rejected promise to the caller as well as trigger the <code>onFailure()</code> hook.</p>
 <div class="tsd-comment tsd-typography"><h4>Description</h4><p>A hook that is triggered after a <code>count()</code> operation.</p>
-</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ExWeiv/weiv-data/blob/9fa4d11aa9ac12bde752ed4dc63ff2d7a9080557/app/weivdata.d.ts#L1430">weivdata.d.ts:1430</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>WeivData API Reference | ExWeiv Apps</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a><br>
+</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ExWeiv/weiv-data/blob/125a272797ae8413bc48312b83b6f3a5023251be/app/weivdata.d.ts#L1430">weivdata.d.ts:1430</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>WeivData API Reference | ExWeiv Apps</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a><br>
             <span id="generation-date"></span>
             <script>
-                window.GENERATION_DATE = 1715759323476;
+                window.GENERATION_DATE = 1715761388766;
 
                 (() => {