Update docs

typhonjs-fvtt-lib · Dec 4, 2024 · 4234b6a · 4234b6a
1 parent cd5d4cc
commit 4234b6a
Show file tree

Hide file tree

Showing 203 changed files with 5,769 additions and 6 deletions.
diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js
diff --git a/docs/classes/_runtime_data_struct_cache_quick-lru.QuickLRU.html b/docs/classes/_runtime_data_struct_cache_quick-lru.QuickLRU.html
diff --git a/docs/classes/_runtime_math_gl-matrix.Mat2.html b/docs/classes/_runtime_math_gl-matrix.Mat2.html
diff --git a/docs/classes/_runtime_math_gl-matrix.Mat2d.html b/docs/classes/_runtime_math_gl-matrix.Mat2d.html
diff --git a/docs/classes/_runtime_math_gl-matrix.Mat3.html b/docs/classes/_runtime_math_gl-matrix.Mat3.html
diff --git a/docs/classes/_runtime_math_gl-matrix.Mat4.html b/docs/classes/_runtime_math_gl-matrix.Mat4.html
diff --git a/docs/classes/_runtime_math_gl-matrix.Quat.html b/docs/classes/_runtime_math_gl-matrix.Quat.html
diff --git a/docs/classes/_runtime_math_gl-matrix.Quat2.html b/docs/classes/_runtime_math_gl-matrix.Quat2.html
diff --git a/docs/classes/_runtime_math_gl-matrix.Vec2.html b/docs/classes/_runtime_math_gl-matrix.Vec2.html
diff --git a/docs/classes/_runtime_math_gl-matrix.Vec3.html b/docs/classes/_runtime_math_gl-matrix.Vec3.html
diff --git a/docs/classes/_runtime_math_gl-matrix.Vec4.html b/docs/classes/_runtime_math_gl-matrix.Vec4.html
diff --git a/docs/classes/_runtime_svelte_store_reducer_array-object.ArrayObjectStore.html b/docs/classes/_runtime_svelte_store_reducer_array-object.ArrayObjectStore.html
diff --git a/docs/classes/_runtime_svelte_store_reducer_array-object.CrudArrayObjectStore.html b/docs/classes/_runtime_svelte_store_reducer_array-object.CrudArrayObjectStore.html
diff --git a/docs/classes/_runtime_svelte_store_reducer_array-object.ObjectEntryStore.html b/docs/classes/_runtime_svelte_store_reducer_array-object.ObjectEntryStore.html
diff --git a/docs/classes/_runtime_svelte_store_web-storage.TJSLocalStorage.html b/docs/classes/_runtime_svelte_store_web-storage.TJSLocalStorage.html
diff --git a/docs/classes/_runtime_svelte_store_web-storage.TJSSessionStorage.html b/docs/classes/_runtime_svelte_store_web-storage.TJSSessionStorage.html
diff --git a/docs/classes/_runtime_svelte_store_web-storage.TJSWebStorage.html b/docs/classes/_runtime_svelte_store_web-storage.TJSWebStorage.html
diff --git a/docs/classes/_runtime_svelte_store_web-storage_msgpack.TJSLocalStorageBCMP.html b/docs/classes/_runtime_svelte_store_web-storage_msgpack.TJSLocalStorageBCMP.html
diff --git a/docs/classes/_runtime_svelte_store_web-storage_msgpack.TJSSessionStorageBCMP.html b/docs/classes/_runtime_svelte_store_web-storage_msgpack.TJSSessionStorageBCMP.html
diff --git a/docs/classes/_runtime_util_loader-module.ModuleLoadError.html b/docs/classes/_runtime_util_loader-module.ModuleLoadError.html
diff --git a/docs/classes/_runtime_util_loader-module.ModuleLoader.html b/docs/classes/_runtime_util_loader-module.ModuleLoader.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><style>body { visibility: hidden; }</style><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>ModuleLoader | TyphonJS Runtime Library (FVTT) 0.2.0</title><meta name="description" content="Documentation for TyphonJS Runtime Library (FVTT) 0.2.0"><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/hierarchy.js" id="tsd-hierarchy-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"><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</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_util_loader-module.html">#runtime/util/loader-module</a></li><li><a href="_runtime_util_loader-module.ModuleLoader.html">ModuleLoader</a></li></ul><div class="dmt-title-header-flex"><h1>Class ModuleLoader</h1></div></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Provides universal loading of ES Modules / CommonJS on Node and ES Modules in the browser.</p>
+<p><a href="../types/_runtime_util_loader-module.ModuleLoaderObj.html" class="tsd-kind-type-alias">ModuleLoaderObj</a> is returned with the loaded module along with metadata that describes the loading mechanism.</p>
+</div><div class="tsd-comment tsd-typography"></div></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_util_loader-module.ModuleLoader.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_util_loader-module.ModuleLoader.html#load" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load</span></a>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open=""><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructormoduleloader" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ModuleLoader</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="_runtime_util_loader-module.ModuleLoader.html" class="tsd-signature-type tsd-kind-class">ModuleLoader</a><a href="#constructormoduleloader" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="_runtime_util_loader-module.ModuleLoader.html" class="tsd-signature-type tsd-kind-class">ModuleLoader</a></h4></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open=""><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="load" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>load</span><a href="#load" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="load-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_runtime_util_loader-module.ModuleLoader.html#loadm">M</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_runtime_util_loader-module.ModuleLoader.html#loade">E</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">modulepath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2024/dom/interfaces/URL-1.html" class="tsd-signature-type external" target="_blank">URL</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">resolveModule</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">M</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_runtime_util_loader-module.ModuleLoader.html#loade">E</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2024/es/interfaces/Promise-1.html" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/_runtime_util_loader-module.ModuleLoaderObj.html" class="tsd-signature-type tsd-kind-type-alias">ModuleLoaderObj</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_runtime_util_loader-module.ModuleLoader.html#loadm">M</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_runtime_util_loader-module.ModuleLoader.html#loade">E</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#load-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="loadm" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">M</span></span></li><li><span><a id="loade" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">E</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">modulepath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2024/dom/interfaces/URL-1.html" class="tsd-signature-type external" target="_blank">URL</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">resolveModule</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">M</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_runtime_util_loader-module.ModuleLoader.html#loade">E</a> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Options object.</p>
+</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">modulepath</span><a class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2024/dom/interfaces/URL-1.html" class="tsd-signature-type external" target="_blank">URL</a></h5><div class="tsd-comment tsd-typography"><p>A module name, file path, or URL.</p>
+</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">resolveModule</span><a class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">M</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_runtime_util_loader-module.ModuleLoader.html#loade">E</a></h5><div class="tsd-comment tsd-typography"><p>An optional function which resolves the import to set <code>instance</code>.</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2024/es/interfaces/Promise-1.html" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/_runtime_util_loader-module.ModuleLoaderObj.html" class="tsd-signature-type tsd-kind-type-alias">ModuleLoaderObj</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_runtime_util_loader-module.ModuleLoader.html#loadm">M</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_runtime_util_loader-module.ModuleLoader.html#loade">E</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The module / instance and data about the loading process.</p>
+<div class="tsd-comment tsd-typography"></div></li></ul></section></section></details></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-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-protected" name="protected" 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>Protected</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" tabindex="-1"><details open="" class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open="" class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#load" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/typhonjs-fvtt-demo/essential-svelte-esm" class="tsd-nav-link">Demo - Essential Svelte ESM</a></nav><nav class="tsd-navigation"><a href="../modules.html">TyphonJS Runtime Library (FVTT) 0.2.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"></ul></nav></div></div></div></main></body></html>