-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
30 lines (27 loc) · 13.3 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@jackdbd/firestore-utils</title><meta name="description" content="Documentation for @jackdbd/firestore-utils"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></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"></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">@jackdbd/firestore-utils</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"><h2>@jackdbd/firestore-utils</h2></div><div class="tsd-panel tsd-typography"><a id="md:jackdbdfirestore-utils" class="tsd-anchor"></a><h1 class="tsd-anchor-link">@jackdbd/firestore-utils<a href="#md:jackdbdfirestore-utils" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><a href="https://badge.fury.io/js/@jackdbd%2Ffirestore-utils" target="_blank" class="external"><img src="https://badge.fury.io/js/@jackdbd%2Ffirestore-utils.svg" alt="npm version"></a>
<img src="https://img.shields.io/snyk/vulnerabilities/npm/@jackdbd%2Ffirestore-utils" alt="Snyk Vulnerabilities for npm package"></p>
<p>Utility functions to work with <a href="https://cloud.google.com/firestore" target="_blank" class="external">Firestore</a>.</p>
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
<details><summary>Table of Contents</summary>
<ul>
<li><a href="#md:installation">Installation</a></li>
<li><a href="#md:usage">Usage</a></li>
<li><a href="#md:api">API</a></li>
</ul>
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
</details>
<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><pre><code class="sh"><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">@jackdbd/firestore-utils</span>
</code><button type="button">Copy</button></pre>
<blockquote>
<p>⚠️ <strong>Warning:</strong></p>
<p>This library declares <a href="https://www.npmjs.com/package/@google-cloud/firestore" target="_blank" class="external">@google-cloud/firestore</a> as peer dependency.</p>
</blockquote>
<a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" 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>You can import the top-level module:</p>
<pre><code class="ts"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Firestore</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'@google-cloud/firestore'</span><br/><span class="hl-3">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">bulkCopy</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">bulkDelete</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">bulkMove</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">moveData</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">shuffleWithFisherYates</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">docResultsWithData</span><br/><span class="hl-1">} </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'@jackdbd/firestore-utils'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">firestore</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">Firestore</span><span class="hl-1">()</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">collection_ref</span><span class="hl-1"> = </span><span class="hl-4">firestore</span><span class="hl-1">.</span><span class="hl-0">collection</span><span class="hl-1">(</span><span class="hl-2">'some-collection'</span><span class="hl-1">)</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">result_copy</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">bulkCopy</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">copied_by:</span><span class="hl-1"> </span><span class="hl-2">'someone'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">dest_collection:</span><span class="hl-1"> </span><span class="hl-2">'some-other-collection'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">query:</span><span class="hl-1"> </span><span class="hl-4">collection_ref</span><span class="hl-1">.</span><span class="hl-0">where</span><span class="hl-1">(</span><span class="hl-2">'some-field'</span><span class="hl-1">, </span><span class="hl-2">'>='</span><span class="hl-1">, </span><span class="hl-7">42</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">result_move</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">bulkMove</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">moved_by:</span><span class="hl-1"> </span><span class="hl-2">'someone'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">dest_collection:</span><span class="hl-1"> </span><span class="hl-2">'some-other-collection'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">query:</span><span class="hl-1"> </span><span class="hl-4">collection_ref</span><span class="hl-1">.</span><span class="hl-0">where</span><span class="hl-1">(</span><span class="hl-2">'some-field'</span><span class="hl-1">, </span><span class="hl-2">'>='</span><span class="hl-1">, </span><span class="hl-7">42</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">shuffleWithFisherYates</span><span class="hl-1">(</span><span class="hl-4">collection_ref</span><span class="hl-1">)</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">result_delete</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">bulkDelete</span><span class="hl-1">({ </span><span class="hl-4">query:</span><span class="hl-1"> </span><span class="hl-4">collection_ref</span><span class="hl-1"> })</span>
</code><button type="button">Copy</button></pre>
<p>or a specific ES module:</p>
<pre><code class="ts"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">bulkCopy</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'@jackdbd/firestore-utils/copy'</span><br/><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">bulkDelete</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'@jackdbd/firestore-utils/delete'</span><br/><br/><span class="hl-3">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">bulkMove</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">moveData</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">shuffleWithFisherYates</span><br/><span class="hl-1">} </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'@jackdbd/firestore-utils/move'</span><br/><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">docResultsWithData</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'@jackdbd/firestore-utils/retrieve'</span>
</code><button type="button">Copy</button></pre>
<a id="md:api" class="tsd-anchor"></a><h2 class="tsd-anchor-link">API<a href="#md:api" 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><a href="https://jackdbd.github.io/calderone/firestore-utils/" target="_blank" class="external">API docs generated with TypeDoc</a></p>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><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>Protected</span></label></li><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><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:jackdbdfirestore-utils"><span>@jackdbd/firestore-<wbr/>utils</span></a><ul><li><a href="#md:installation"><span>Installation</span></a></li><li><a href="#md:usage"><span>Usage</span></a></li><li><a href="#md:api"><span>API</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@jackdbd/firestore-utils</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></p></footer><div class="overlay"></div></body></html>