Update docs.

typhonjs-fvtt-lib · Sep 16, 2024 · 24c998d · 24c998d
1 parent 88661e3
commit 24c998d
Show file tree

Hide file tree

Showing 242 changed files with 839 additions and 243 deletions.
diff --git a/docs/assets/dmt/dmt-components.js b/docs/assets/dmt/dmt-components.js
@@ -6342,6 +6342,9 @@ class DetailsAccordion
             // Otherwise hook up a "one off" details element.
             const store = this.#detailsSessionStorage.getStore(key, detailEl.open);
             this.#toggleDetailsActionReturns.push(toggleDetails(detailEl, { store }));
+
+            // Ensure that when TypeDoc modifies the open state to update store.
+            detailEl.addEventListener('toggle', (event) => store.set(event.target.open));
          }
       }
 
@@ -6367,6 +6370,9 @@ class DetailsAccordion
          for (const detailEl of detailElSet)
          {
             this.#toggleDetailsActionReturns.push(toggleDetails(detailEl, { store }));
+
+            // Ensure that when TypeDoc modifies the open state to update store.
+            detailEl.addEventListener('toggle', (event) => store.set(event.target.open));
          }
       }
 

diff --git a/docs/classes/_runtime_data_compress.AsyncUnzipInflate.html b/docs/classes/_runtime_data_compress.AsyncUnzipInflate.html
@@ -1,6 +1,16 @@
 <!DOCTYPE html><html class="default" lang="en"><head><style>body { visibility: hidden; }</style><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>AsyncUnzipInflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1</title><meta name="description" content="Documentation for TyphonJS Runtime Library (FVTT) 0.2.0-next.1"><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><link rel="stylesheet" href="../assets/dmt/dmt-components.css"><link rel="stylesheet" href="../assets/dmt/dmt-theme.css"><script src="../assets/dmt/dmt-components.js" type="module"></script><link rel="icon" href="../favicon.ico"><noscript><style>body { visibility: visible; }</style></noscript></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";</script><div class="overlay"></div>
 <main><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field" id="dmt-search-main"></div><div class="field" id="dmt-toolbar"><a href="../index.html" class="title">TyphonJS Runtime Library (FVTT) 0.2.0-next.1</a></div></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" tabindex="-1"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules/_runtime_data_compress.html">#runtime/data/compress</a></li><li><a href="_runtime_data_compress.AsyncUnzipInflate.html">AsyncUnzipInflate</a></li></ul><div class="dmt-title-header-flex"><h1>Class AsyncUnzipInflate</h1></div></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Asynchronous streaming DEFLATE decompression for ZIP archives</p>
-</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_runtime_data_compress.UnzipDecoder.html" class="tsd-signature-type tsd-kind-interface">UnzipDecoder</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open=""><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" aria-expanded="false"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_runtime_data_compress.AsyncUnzipInflate.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel-group tsd-hierarchy">
+           <details class="tsd-hierarchy tsd-accordion">
+           <summary class="tsd-accordion-summary" data-key="reflection-implements">
+              <h5>
+                 <svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Implements
+              </h5>
+           </summary>
+           <div class="tsd-accordion-details">
+           <ul class="tsd-hierarchy"><li><a href="../interfaces/_runtime_data_compress.UnzipDecoder.html" class="tsd-signature-type tsd-kind-interface">UnzipDecoder</a></li></ul></div>
+           </details>
+           </section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open=""><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" aria-expanded="false"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_runtime_data_compress.AsyncUnzipInflate.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_runtime_data_compress.AsyncUnzipInflate.html#push" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>push</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_runtime_data_compress.AsyncUnzipInflate.html#ondata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ondata</span></a>
 <a href="_runtime_data_compress.AsyncUnzipInflate.html#terminate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>terminate</span></a>

diff --git a/docs/classes/_runtime_data_compress.AsyncZipDeflate.html b/docs/classes/_runtime_data_compress.AsyncZipDeflate.html
@@ -1,6 +1,16 @@
 <!DOCTYPE html><html class="default" lang="en"><head><style>body { visibility: hidden; }</style><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>AsyncZipDeflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1</title><meta name="description" content="Documentation for TyphonJS Runtime Library (FVTT) 0.2.0-next.1"><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><link rel="stylesheet" href="../assets/dmt/dmt-components.css"><link rel="stylesheet" href="../assets/dmt/dmt-theme.css"><script src="../assets/dmt/dmt-components.js" type="module"></script><link rel="icon" href="../favicon.ico"><noscript><style>body { visibility: visible; }</style></noscript></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";</script><div class="overlay"></div>
 <main><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field" id="dmt-search-main"></div><div class="field" id="dmt-toolbar"><a href="../index.html" class="title">TyphonJS Runtime Library (FVTT) 0.2.0-next.1</a></div></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" tabindex="-1"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules/_runtime_data_compress.html">#runtime/data/compress</a></li><li><a href="_runtime_data_compress.AsyncZipDeflate.html">AsyncZipDeflate</a></li></ul><div class="dmt-title-header-flex"><h1>Class AsyncZipDeflate</h1></div></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Asynchronous streaming DEFLATE compression for ZIP archives</p>
-</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_runtime_data_compress.ZipInputFile.html" class="tsd-signature-type tsd-kind-interface">ZipInputFile</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open=""><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" aria-expanded="false"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_runtime_data_compress.AsyncZipDeflate.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel-group tsd-hierarchy">
+           <details class="tsd-hierarchy tsd-accordion">
+           <summary class="tsd-accordion-summary" data-key="reflection-implements">
+              <h5>
+                 <svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Implements
+              </h5>
+           </summary>
+           <div class="tsd-accordion-details">
+           <ul class="tsd-hierarchy"><li><a href="../interfaces/_runtime_data_compress.ZipInputFile.html" class="tsd-signature-type tsd-kind-interface">ZipInputFile</a></li></ul></div>
+           </details>
+           </section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open=""><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" aria-expanded="false"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_runtime_data_compress.AsyncZipDeflate.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_runtime_data_compress.AsyncZipDeflate.html#process" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>process</span></a>
 <a href="_runtime_data_compress.AsyncZipDeflate.html#push" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>push</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_runtime_data_compress.AsyncZipDeflate.html#attrs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attrs?</span></a>

diff --git a/docs/classes/_runtime_data_compress.UnzipInflate.html b/docs/classes/_runtime_data_compress.UnzipInflate.html
@@ -1,7 +1,17 @@
 <!DOCTYPE html><html class="default" lang="en"><head><style>body { visibility: hidden; }</style><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>UnzipInflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1</title><meta name="description" content="Documentation for TyphonJS Runtime Library (FVTT) 0.2.0-next.1"><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><link rel="stylesheet" href="../assets/dmt/dmt-components.css"><link rel="stylesheet" href="../assets/dmt/dmt-theme.css"><script src="../assets/dmt/dmt-components.js" type="module"></script><link rel="icon" href="../favicon.ico"><noscript><style>body { visibility: visible; }</style></noscript></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";</script><div class="overlay"></div>
 <main><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field" id="dmt-search-main"></div><div class="field" id="dmt-toolbar"><a href="../index.html" class="title">TyphonJS Runtime Library (FVTT) 0.2.0-next.1</a></div></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" tabindex="-1"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules/_runtime_data_compress.html">#runtime/data/compress</a></li><li><a href="_runtime_data_compress.UnzipInflate.html">UnzipInflate</a></li></ul><div class="dmt-title-header-flex"><h1>Class UnzipInflate</h1></div></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Streaming DEFLATE decompression for ZIP archives. Prefer AsyncZipInflate for
 better performance.</p>
-</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_runtime_data_compress.UnzipDecoder.html" class="tsd-signature-type tsd-kind-interface">UnzipDecoder</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open=""><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" aria-expanded="false"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_runtime_data_compress.UnzipInflate.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel-group tsd-hierarchy">
+           <details class="tsd-hierarchy tsd-accordion">
+           <summary class="tsd-accordion-summary" data-key="reflection-implements">
+              <h5>
+                 <svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Implements
+              </h5>
+           </summary>
+           <div class="tsd-accordion-details">
+           <ul class="tsd-hierarchy"><li><a href="../interfaces/_runtime_data_compress.UnzipDecoder.html" class="tsd-signature-type tsd-kind-interface">UnzipDecoder</a></li></ul></div>
+           </details>
+           </section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open=""><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" aria-expanded="false"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_runtime_data_compress.UnzipInflate.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_runtime_data_compress.UnzipInflate.html#push" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>push</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_runtime_data_compress.UnzipInflate.html#ondata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ondata</span></a>
 <a href="_runtime_data_compress.UnzipInflate.html#compression" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>compression</span></a>