From 0597a43c6a5824115d23ea591fa0d70df310101e Mon Sep 17 00:00:00 2001 From: Nikola Hristov Date: Thu, 9 Jan 2025 05:54:13 +0200 Subject: [PATCH] AstroCritters/v2.2.1 --- Target/Function/Integration.d.ts | 39 + Target/Function/Integration.js | 1 + Target/Function/Merge.d.ts | 16 + Target/Function/Merge.js | 1 + Target/Interface/Critters.d.ts | 25 + Target/Interface/Critters.js | 0 Target/Interface/Integration.d.ts | 9 + Target/Interface/Integration.js | 0 Target/Interface/Logger.d.ts | 11 + Target/Interface/Logger.js | 0 Target/Interface/Option.d.ts | 9 + Target/Interface/Option.js | 0 Target/Variable/Critters.d.ts | 7 + Target/Variable/Critters.js | 1 + Target/Variable/Option.d.ts | 25 + Target/Variable/Option.js | 1 + docs/.nojekyll | 1 + docs/assets/custom.css | 54 + docs/assets/highlight.css | 92 + docs/assets/icons.js | 18 + docs/assets/icons.svg | 1 + docs/assets/main.js | 60 + docs/assets/navigation.js | 1 + docs/assets/search.js | 1 + docs/assets/style.css | 1493 +++++++++++++++++ .../functions/Function_Integration.Merge.html | 1 + .../Function_Integration.integration.html | 1 + docs/functions/Merge.merge.html | 1 + docs/index.html | 79 + docs/interfaces/Critters.Interface.html | 6 + .../Interface_Critters.Interface.html | 19 + .../Interface_Integration.Interface.html | 1 + .../Interface_Option.Interface.html | 23 + docs/media/CHANGELOG.md | 373 ++++ docs/modules.html | 9 + docs/modules/Critters.html | 2 + docs/modules/Function_Integration.html | 5 + docs/modules/Interface_Critters.html | 2 + docs/modules/Interface_Integration.html | 2 + docs/modules/Interface_Option.html | 2 + docs/modules/Merge.html | 2 + docs/modules/Variable_Critters.html | 2 + docs/modules/Variable_Option.html | 2 + .../Function_Integration.Default.html | 1 + .../Function_Integration.Search.html | 1 + .../variables/Variable_Critters.critters.html | 1 + docs/variables/Variable_Option.option.html | 1 + 47 files changed, 2402 insertions(+) create mode 100644 Target/Function/Integration.d.ts create mode 100644 Target/Function/Integration.js create mode 100644 Target/Function/Merge.d.ts create mode 100644 Target/Function/Merge.js create mode 100644 Target/Interface/Critters.d.ts create mode 100644 Target/Interface/Critters.js create mode 100644 Target/Interface/Integration.d.ts create mode 100644 Target/Interface/Integration.js create mode 100644 Target/Interface/Logger.d.ts create mode 100644 Target/Interface/Logger.js create mode 100644 Target/Interface/Option.d.ts create mode 100644 Target/Interface/Option.js create mode 100644 Target/Variable/Critters.d.ts create mode 100644 Target/Variable/Critters.js create mode 100644 Target/Variable/Option.d.ts create mode 100644 Target/Variable/Option.js create mode 100644 docs/.nojekyll create mode 100644 docs/assets/custom.css create mode 100644 docs/assets/highlight.css create mode 100644 docs/assets/icons.js create mode 100644 docs/assets/icons.svg create mode 100644 docs/assets/main.js create mode 100644 docs/assets/navigation.js create mode 100644 docs/assets/search.js create mode 100644 docs/assets/style.css create mode 100644 docs/functions/Function_Integration.Merge.html create mode 100644 docs/functions/Function_Integration.integration.html create mode 100644 docs/functions/Merge.merge.html create mode 100644 docs/index.html create mode 100644 docs/interfaces/Critters.Interface.html create mode 100644 docs/interfaces/Interface_Critters.Interface.html create mode 100644 docs/interfaces/Interface_Integration.Interface.html create mode 100644 docs/interfaces/Interface_Option.Interface.html create mode 100644 docs/media/CHANGELOG.md create mode 100644 docs/modules.html create mode 100644 docs/modules/Critters.html create mode 100644 docs/modules/Function_Integration.html create mode 100644 docs/modules/Interface_Critters.html create mode 100644 docs/modules/Interface_Integration.html create mode 100644 docs/modules/Interface_Option.html create mode 100644 docs/modules/Merge.html create mode 100644 docs/modules/Variable_Critters.html create mode 100644 docs/modules/Variable_Option.html create mode 100644 docs/variables/Function_Integration.Default.html create mode 100644 docs/variables/Function_Integration.Search.html create mode 100644 docs/variables/Variable_Critters.critters.html create mode 100644 docs/variables/Variable_Option.option.html diff --git a/Target/Function/Integration.d.ts b/Target/Function/Integration.d.ts new file mode 100644 index 00000000..a8eab541 --- /dev/null +++ b/Target/Function/Integration.d.ts @@ -0,0 +1,39 @@ +import type Interface from "../Interface/Integration.js"; +/** + * @module Integration + * + */ +declare const _default: Interface; +export default _default; +export declare const Default: { + File: string; + Cache: { + Search: string; + Folder: string; + }; + Path: string; + Logger: 2; + Action: { + Accomplished: false; + Failed: (On: import("@playform/pipe/Target/Interface/File.js").default) => Promise; + Fulfilled: ({ File }: import("@playform/pipe/Target/Interface/Plan.js").default) => Promise; + Read: ({ Input }: import("@playform/pipe/Target/Interface/File.js").default) => Promise; + Wrote: ({ Buffer }: import("@playform/pipe/Target/Interface/File.js").default) => Promise; + Passed: (On: import("@playform/pipe/Target/Interface/File.js").default) => Promise; + Changed: (Plan: import("@playform/pipe/Target/Interface/Plan.js").default) => Promise; + }; + Exclude: false; + Critters: import("../Interface/Critters.js").default; +}; +export declare const Search: string; +export declare const Merge: (...objects: Ts) => import("deepmerge-ts").DeepMergeHKT, Readonly<{ + key: PropertyKey; + parents: ReadonlyArray>>; +}>>; diff --git a/Target/Function/Integration.js b/Target/Function/Integration.js new file mode 100644 index 00000000..05028ef8 --- /dev/null +++ b/Target/Function/Integration.js @@ -0,0 +1 @@ +import h from"critters";var w=(...[i={}])=>{Object.entries(i).forEach(([t,e])=>Object.defineProperty(i,t,{value:e===!0?p[t]:i[t]}));const{Action:l,Cache:n,Critters:s,Exclude:u,Logger:c,Path:a}=f(p,i),r=new Set;return typeof a<"u"&&((Array.isArray(a)||a instanceof Set)&&a.forEach(t=>r.add(t)),a instanceof Map&&r.add(a)),{name:"astro-critters",hooks:{"astro:build:done":async({dir:t})=>{if(r.size===0&&r.add(t),typeof n=="object"&&n.Search===m&&(n.Search=t),!!s)for(let e of r){e=await(await import("@playform/pipe/Target/Function/Apply.js")).default(async o=>o instanceof URL?(await import("url")).fileURLToPath(o):o,e);const d=new h(f(s,{path:e instanceof Map?e.keys().next().value:e,logLevel:(()=>{switch(c){case 0:return"silent";case 1:return"silent";case 2:return"info";default:return"info"}})()}));await(await(await(await new(await import("@playform/pipe")).default(n,c).In(e)).By("**/*.html")).Not(u)).Pipe(f(l,{Wrote:async({Buffer:o})=>d.process(o.toString())}))}}}}};const{default:p}=await import("../Variable/Option.js"),{default:{Cache:{Search:m}}}=await import("@playform/pipe/Target/Variable/Option.js"),{default:f}=await import("./Merge.js");export{p as Default,f as Merge,m as Search,w as default}; diff --git a/Target/Function/Merge.d.ts b/Target/Function/Merge.d.ts new file mode 100644 index 00000000..b03db589 --- /dev/null +++ b/Target/Function/Merge.d.ts @@ -0,0 +1,16 @@ +/** + * @module Merge + * + */ +declare const _default: (...objects: Ts) => import("deepmerge-ts").DeepMergeHKT, Readonly<{ + key: PropertyKey; + parents: ReadonlyArray>>; +}>>; +export default _default; diff --git a/Target/Function/Merge.js b/Target/Function/Merge.js new file mode 100644 index 00000000..e898449a --- /dev/null +++ b/Target/Function/Merge.js @@ -0,0 +1 @@ +var e=(await import("deepmerge-ts")).deepmergeCustom({mergeArrays:!1});export{e as default}; diff --git a/Target/Interface/Critters.d.ts b/Target/Interface/Critters.d.ts new file mode 100644 index 00000000..1ff8e3d2 --- /dev/null +++ b/Target/Interface/Critters.d.ts @@ -0,0 +1,25 @@ +import type Logger from "../Interface/Logger.js"; +/** + * @module Critters + * + */ +export default interface Interface { + path?: string; + publicPath?: string; + external?: boolean; + inlineThreshold?: number; + minimumExternalSize?: number; + pruneSource?: boolean; + mergeStylesheets?: boolean; + additionalStylesheets?: string[]; + preload?: "body" | "media" | "swap" | "js" | "js-lazy"; + noscriptFallback?: boolean; + inlineFonts?: boolean; + preloadFonts?: boolean; + fonts?: boolean; + keyframes?: string; + compress?: boolean; + logLevel?: "info" | "warn" | "error" | "trace" | "debug" | "silent"; + reduceInlineStyles?: boolean; + logger?: Logger; +} diff --git a/Target/Interface/Critters.js b/Target/Interface/Critters.js new file mode 100644 index 00000000..e69de29b diff --git a/Target/Interface/Integration.d.ts b/Target/Interface/Integration.d.ts new file mode 100644 index 00000000..88c1b86b --- /dev/null +++ b/Target/Interface/Integration.d.ts @@ -0,0 +1,9 @@ +import type { AstroIntegration } from "astro"; +import type Option from "../Interface/Option.js"; +/** + * @module Integration + * + */ +export default interface Interface { + (Option?: Option): AstroIntegration; +} diff --git a/Target/Interface/Integration.js b/Target/Interface/Integration.js new file mode 100644 index 00000000..e69de29b diff --git a/Target/Interface/Logger.d.ts b/Target/Interface/Logger.d.ts new file mode 100644 index 00000000..8ac4c3a3 --- /dev/null +++ b/Target/Interface/Logger.d.ts @@ -0,0 +1,11 @@ +/** + * @module Critters + * + */ +export default interface Interface { + trace?: (message: string) => void; + debug?: (message: string) => void; + info?: (message: string) => void; + warn?: (message: string) => void; + error?: (message: string) => void; +} diff --git a/Target/Interface/Logger.js b/Target/Interface/Logger.js new file mode 100644 index 00000000..e69de29b diff --git a/Target/Interface/Option.d.ts b/Target/Interface/Option.d.ts new file mode 100644 index 00000000..f030ef7f --- /dev/null +++ b/Target/Interface/Option.d.ts @@ -0,0 +1,9 @@ +import type Option from "@playform/pipe/Target/Interface/Option.js"; +import type Critters from "../Interface/Critters.js"; +/** + * @module Option + * + */ +export default interface Interface extends Option { + Critters?: boolean | Critters; +} diff --git a/Target/Interface/Option.js b/Target/Interface/Option.js new file mode 100644 index 00000000..e69de29b diff --git a/Target/Variable/Critters.d.ts b/Target/Variable/Critters.d.ts new file mode 100644 index 00000000..af833693 --- /dev/null +++ b/Target/Variable/Critters.d.ts @@ -0,0 +1,7 @@ +import type Interface from "../Interface/Critters.js"; +/** + * @module Critters + * + */ +declare const _default: Interface; +export default _default; diff --git a/Target/Variable/Critters.js b/Target/Variable/Critters.js new file mode 100644 index 00000000..b0bef245 --- /dev/null +++ b/Target/Variable/Critters.js @@ -0,0 +1 @@ +var e={preload:"media",inlineFonts:!0,compress:!0,pruneSource:!0,reduceInlineStyles:!1};export{e as default}; diff --git a/Target/Variable/Option.d.ts b/Target/Variable/Option.d.ts new file mode 100644 index 00000000..7fbacb2e --- /dev/null +++ b/Target/Variable/Option.d.ts @@ -0,0 +1,25 @@ +/** + * @module Option + * + */ +declare const _default: { + File: string; + Cache: { + Search: string; + Folder: string; + }; + Path: string; + Logger: 2; + Action: { + Accomplished: false; + Failed: (On: import("@playform/pipe/Target/Interface/File.js").default) => Promise; + Fulfilled: ({ File }: import("@playform/pipe/Target/Interface/Plan.js").default) => Promise; + Read: ({ Input }: import("@playform/pipe/Target/Interface/File.js").default) => Promise; + Wrote: ({ Buffer }: import("@playform/pipe/Target/Interface/File.js").default) => Promise; + Passed: (On: import("@playform/pipe/Target/Interface/File.js").default) => Promise; + Changed: (Plan: import("@playform/pipe/Target/Interface/Plan.js").default) => Promise; + }; + Exclude: false; + Critters: import("../Interface/Critters.js").default; +}; +export default _default; diff --git a/Target/Variable/Option.js b/Target/Variable/Option.js new file mode 100644 index 00000000..42e8a3ae --- /dev/null +++ b/Target/Variable/Option.js @@ -0,0 +1 @@ +var e=(await import("../Function/Merge.js")).default((await import("@playform/pipe/Target/Variable/Option.js")).default,{Critters:(await import("./Critters.js")).default,Action:{Failed:async t=>`Error: Cannot inline file ${t.Input}!`,Fulfilled:async({File:t})=>t>0?`Successfully inlined a total of ${t} HTML ${t===1?"file":"files"}.`:!1,Accomplished:!1}});export{e as default}; diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 00000000..e2ac6616 --- /dev/null +++ b/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/custom.css b/docs/assets/custom.css new file mode 100644 index 00000000..e360ec98 --- /dev/null +++ b/docs/assets/custom.css @@ -0,0 +1,54 @@ +:root { + --dark-color-background: #000; + --dark-color-background-secondary: #000; + --dark-code-background: #040404; + --color-accent: #2463eb; + --light-hl-0: #b58900; + --light-hl-1: #d33682; + --light-hl-2: #dc322f; + --light-hl-3: #2aa198; + --light-hl-4: #859900; + --dark-hl-0: #ffdd00; + --dark-hl-1: #ff66ff; + --dark-hl-2: #ff4444; + --dark-hl-3: #44ffff; + --dark-hl-4: #44ff44; +} + +body #tsd-search .field label { + left: 50%; + margin-left: -20px; + z-index: 1; + text-align: center; +} + +body #tsd-search.has-focus .field label { + display: none; +} + +body #tsd-search .field input { + z-index: 2; +} + +body pre, +body .tsd-page-toolbar, +body .tsd-generator { + border: none; +} + +body .tsd-navigation a, +body .tsd-navigation summary > span, +body .tsd-page-navigation a { + padding: 0.5rem; + border-radius: 8px; +} + +body .tsd-description .tsd-signatures .tsd-signature, +body .tsd-signature, +body .tsd-signatures .tsd-signature, +body .tsd-typography td, +body .tsd-typography th, +body code.tsd-tag { + border-radius: 12px; + border-width: 2px; +} diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css new file mode 100644 index 00000000..146cd454 --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,92 @@ +:root { + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #0000FF; + --dark-hl-3: #569CD6; + --light-hl-4: #AF00DB; + --dark-hl-4: #C586C0; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #008000; + --dark-hl-6: #6A9955; + --light-hl-7: #267F99; + --dark-hl-7: #4EC9B0; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; + --light-hl-9: #000000; + --dark-hl-9: #C8C8C8; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/icons.js b/docs/assets/icons.js new file mode 100644 index 00000000..3dfbd322 --- /dev/null +++ b/docs/assets/icons.js @@ -0,0 +1,18 @@ +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); + } + + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg new file mode 100644 index 00000000..a19417dc --- /dev/null +++ b/docs/assets/icons.svg @@ -0,0 +1 @@ +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js new file mode 100644 index 00000000..99097a05 --- /dev/null +++ b/docs/assets/main.js @@ -0,0 +1,60 @@ +"use strict"; +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings."}; +"use strict";(()=>{var Pe=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Pe(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!Ve(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function Ve(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{ce(e,t)}),ce(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),He(t,i,r,e)}function He(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Be(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Be(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),te(e)}}function he(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",N="mouseup",J={x:0,y:0},me=!1,ne=!1,qe=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(qe=!0,F="touchstart",ye="touchmove",N="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(N,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span"));r.innerHTML='',r.appendChild(document.createElement("span")).textContent=t.text}}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});fe();we();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 00000000..3d3f90fe --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAACq3UQWuDMBQH8O/yzrKC3XrwujHYYeww2KVIyeKzhmks6XMMht99tCYxq4mN0Jvoy4+/yV+3v0D4Q5DBoxJEqI6QwIFRBRk0bdHVeFyZJ3cVNTUk8CVkAVmaAK9EXSiUkG0t8yIJVck4jo4wtxzKjl2gD5s+7xOrPXeSk2jl6jS/V+x0PQ1opnbOVFTYJyxZV9MofjMl2GfQ1PP/7XXqBH5HpngVDQ7jM57wvXepqQAqQruwuXfkV1R7jDbP0xPNPSr34H17He6XXbm7YdM8aGTnZqs2sku7FhvXdSMTvx2uhR0mbppTk7MR83DfTEZPsQLBmlBhB6K52tAP/S0uLqhZuKyffOKNP4OpyL30Oo06aMstOOf2wvKE01rrQc/B8j7/A0GzT/1ABgAA" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 00000000..16c6b4ea --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACtWdXY/buhGG/4ty0wvFkfjNvSvaEyDAKVo0xenFIggcW7srxGsvZDvnnAb57wUl0uKIHIvSapHkSo4kzrwcPvzQSMt8zZrD78fs5vZr9rneb7Mbkmf79WOV3WTv9qequVtvqjf/fDrVh32WZ+dml91kj4fteVcd31xu+NjdsHo4Pe6yPNvs1sdjdcxusuxbfrHLRWj5YrJ2ZyJWLyci9vPsad1U+1NMbu+7LAi7OP9bU59OVXOc4fuVVzZNRG8AlbPePMyJwytXsBdyOm5f18fX9f6haupTtX2esH+tTw9zdNlyLyXrlz82u/N2VsT6oi8l7m29m6XMlnspWX/dgP47Qdil5EtJ+/Vwf181c6RdSi4ojeCjhBv03IVlBruLtcRB7iILCeepmebolStw3V00WIJz2lfz48fTn0/TXa+6cq/FBA2rTjQSgm316Xw/RYcr8B1C0LpeXcolB6CTjASg3t8dpoiw93+H6hvPDgA2pf6tZKT6v6+b6FCHibD3f4fqG8+u+mpK9VvJSPWrpjlEx1NMhSvwHQLQunYRIFMi0ImODdz9OG9+3TfrkaWrd9fS61ff9ORFrK/+ej3RqapXsuykFbE7uXpjE9nT6OoTg+ppuP68LmB8ifJ0/rSrN+PLYVSQX345WdUfp6rZr3fzRHmll5NU73f1vvrPQ1MdHw677TxloZHlBD7W+/rx/PiLrfz7+n/zAH8VN7Qgc815X70/nJuZPfAVNLBgBKvmvnp/+nNXHR+q6jTyFI2GL7SynMT1dlubYXO9e7ZOzNSSDV3tDuuZXaUvvJyg/eG4aeqn09v1bvdpvfk8T1nEytLDzNvDfm6zQgOLN+YzlA0sLCftbr6mu8XFfK7+vGvWj9VMQX7x5URtDo9PTXWcqckrvZyk3eH+1+pLNXOK90ovJ6mptudN9a7tQN2YOE9c1M6ikRtNK12J2zCxNENOv1L/bd3U6087NI3urqdk0Wlv9gCtfbFWQnsHzKxXqaHGxGe8JKevRvIbA9+2aFKKdYr/VZBkHRfhUjNJuftJYsLs/Rw1izVOp8c9ipd4MuaqMlsrJFrvq3WzeVhE3upia7bKkaZ9e9htvQHkWWIvtl5KLHg2nST16lPprD4xSOhPUhNJ6T9bz+DdxyQ9kbcf37eXdoIuaM1EylYLDZhZy+zq40O1XUTlamBxvuSxPruud0tpvthaUu2LgWDljufSJ+h2IcCCfd7d1bvl4u2Z+0lC7hSPv8KaFPVLIJDA/7taLxRza+nnCLcRe/lXsUio2/ojUf5vczgtpNyZ+jni3Kq9/BN/KTMl0F0E0MXL8bjUKHKx9XPEupM7/gpwSqxtCLAnlof1/n6paPfGfo5wW73jLxynxNsFIfFzpUkViH2w9PyH1uHrwmnPNmNfwKVqiuRH0BeZF11J7zG9HMkmoa4XmxvceKx+kTeYveN/mBccQT3as1e1i8GblouJu/O+xc4ZeURMeUo7DTF1b62xq6/I3U3Jb8i9uP+9ulufd6dI2KNW7e3XqxMVPXnYGPU/lq2KyXAGJuasUrVcz1xdEzQzf5Us7HoWa5qyhRswOaOVoHJmXmuu1LHsVrLiuTmu2cJHMl1LCUfyXcmyr2a9ntGf0NxXsrKRDNgztKF5sGRtI9mw79vbUzNjKQg+Kz82V3Falixd/txc2Wz9Ixmz5yh/YViSs2eT6/CMHNr8yoxm0n7opkjPqs1ojZm5tdm1uZph+5GbITHbNr0J5uTcZtfieubtR45/ahZuegPMy8XNrshIRu5HboPU7Nz0Npibo5tdlbFM3Y/cDMlZu+ntMDt3l1yZsQzecx7e8dxW+vPbWDZvmj4vAzTtobi7+3n5H4Yk3/rMWdQ1lpOb5bmO5NNG/HtF5qj4kGf1flv9kd18zb5UzdGcvMnIiq50lmd3dbXbmr/u7gTm5iPHR2Muz7aHzbn9+cHe9lu1OR0ac3N395siy2+LnJEVU/zDh/zWFW4vtCecjf5MW7DM8tsyp+WKaQ0KlkHBEhQkWX5LcqJXTBNQkAQFCShIs/yWxjx2F4oVK1jO8mJFCM+5PQpzZDKX9qjseZ0XK0VYXhbmRKHysuyuQAUUKGCmziQmwVwxrikXrWtzNK6pLlvX0ro257U9lq1mNvDIgEduPLKcslVRwmiZK8aTkGVemh+KqrwU7ofsfkDbHNgWxraK1cZeKVa80Hlp9AolclK4H6X7Qbof0IsAXqRp7mizSRszJcqcmFhILXPTJKtCDkxKYFIZkzxm0lxpdXcNzHlOhNMq3Q8VE62AB40xqgNGNewVBdotwg5VDnqU6SdExzpjGelUsFeZ5eMtLfKSrbSEZcN+VcKOVbYdqIw6pmFh2CdM0hVxzMKykO7SAElJ1DEPC0N8S4E6FmFZCGVpgKI06liGhSF+pUIdq7AsBKs0uFAWdRyyVUK4SIE5JiFcBMJFDC6UxxyTEC4yGLIJRjWJDNoQLtLCJaKOQ7gIhIsw1HEIF4FwEY6O1iSEi0C4SAuXjKoO6SKQLtLSpaKFQ7oIpIu0dEVHARLiRSBexADDovM5CfEiEC9qiGHRYYCGfFHIFzXEsGhXpiFfFPJFDTIs2h1pCBgdLAsMMizapWgIGIWA0XbijnYLGhJGIWHUMMOiaNOQMAoJo4YZFiWMhoRRSBht584oYTQkjELCqGGGRQmjIWEUEkYNMzxKGA0Jo5AwZpjhUcJYSBiDhDHDDI8SxkLCGCSMEXTNwELCGCSMGWZ4FE8WEsYGa0bDDI/iyULCGCSMcWzEZyFgDALG8PUdCwFjEDAmscU2C/likC+Gzo8sxItBvJgBpiyijkO8GMSLt4uvMrpaDvHiEC9eotMFD/HiEC+O48VDvDjEi1N0icxDvDjEi6PLLx7SxQcPF+0zBM+pXFE5KBzixSFe3ADDRbRwiBeHeHGJqg7x4hAvbojhMuo45ItDvrhGHYd4cYiXaEcvFXMsQrwExEuUmGMR0iUgXcLwwnXUcUiXgHQJijoO4RIQLmF4EUXUcUiXgHQJdOwSIVxi8GhqcBFl1HEIl4BwCRQuEcIlIFxCoQ/cIoRLQLgE+tgoQrgEhEsaXER0dpMhXBLCJUvMsQzhkhAuaXARNFZjGcIlIVyS4oVDuiSkS7Z0RWdGGdIlIV3SACOiCzcZ4iUhXhJ9dJQhXXKQz5DotCpDvCTESypsWpUhXRLSJdGhS4Z0SUiXKtBpVYV0KUiXKtFpVYV4KYiXIui0qkK8FMRLUTzTE+KlIF6KodOqCvFSEC+FDl4qpEtBupRAp1UV4qUgXkqi06oK8VKDxBi68lIhXgripTQ6raqQLwX50mhmQod4aYiXLtFpVYd4aYiXRtNeOqRLQ7o0RadVHdKlIV0aXXfpEC4N4dIcnVZ1SJeGdGl07NIhXBrCpSU6reoQLg3h0ihcOoRLD/KpGp1WdSSlOsypFtj01l2Cpb1ztniJDn7dtWH5QWa1wGfI7tqw/CC7WrSTZDRN0F0blu/OtS99vlTNqdq+617+3N5mWf41+2jfBWn3Rurrt/6dz83XjHZnWHdQ5vDNexVk/mkcEt8WUYgxtLh7B9zboMXFRlaSzlJpVZTCHlV3JIUVye3Rnuf2fi7tUXdHUdqjrZyw5YS9T1r70t6v7HVl7WrrT1td2vrRtpx29eyrHqv0Gny+11ed877q3LkWiSa7F4leW9DemAuDrbZigc3ulqjly75GR39fo94R8xxRkqT2E2hxUiLUCEzTpvuW3IPGk2BRcE0aNkl3S9Su+/ahtyx6cZlwzSyTatnv8+I1sUc31Ylm9nf1/dm9KvYCn9Rz0YY1f8NSNfXaN1lyxCa/ZqX7LMBr0L6OrqPYfmaP0vZDM8imhMBuu+q1t9cqJU23cV/vgR0ipg5YW/fnKh4iXreVPEmM3UjTqxDzKpTGReW+F/Gaz7PihjY3dE0xOohSiUUJpaLfMtCrovKwSOtBd/Y7Ya//CK+GtjuqRGPtX8Z4tfL0WEvMjf+hRXwwMnYB/qWcGq47+7cQng0PcG5nHVVOGMrsTlzeaOFVlyZGDDKKjQ1wvMEr2X9s7NmUXj0tqioNVfexzBvwJY3XLb3OIMMZL2ay297YQ9Ybycq0nt3tFxdG3+OWTrF06je39HRpryulrTmwIHm6zJIx1ZTd8NUD1rPjBvfuSOwcQFLbwO2ZFZtaqKeXTJSLgUK98ZuEfey6Tbe1Vm/Om+HTZjdvjzoPGK+JaVoT77od3LzZDRuI0NnN7Wfm2fCCY/snsw3K7VGltcPucB8o5B42LC1aj+vTZrBuJgSpJzpm2z+Y9fqBv1q29ZLUgZy2qm2NYotkbyShaYzZfWPdVHps9431LHqckbQR0+20eXfZadMz57UzTeupIfrcG3JZmpEn+9G31xRexYR7wEobMrv9nL1ByYu6tUTsuojbUUqlta2x/Bc4y1MEOoZB97Q2w9keWsEev1F0n2r4vEywxwB04X/ZCtZrfa/haFp3tlbCmc6b0Wnaw2u7AfHRbkDsWfIGB5o2OHT7Zw8xoJ4kkiapqWCAuL9YdFmAtH7cbV/ZzeZHu32lZ9hHNM3g0X4v7VHkdRnmcheFG72mLBtP6+a+Ak832Bzir/qiluATOvYIMWoGLMhIMbW72P+0xDPhTaxlWsAh4FiOKzFh5j5vjy5vhEeDTEP+Yi8yHHuTGkvr1d3/cOF1Hc9EmfbU8Hv3l1SeDC/iwiUEEuR8yNvBzvSb7Ob2w7dv/wezk7c2gWwAAA=="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css new file mode 100644 index 00000000..178bfb02 --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1493 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + + --light-color-icon-background: var(--light-color-background); + --light-color-icon-text: var(--light-color-text); + + --light-color-comment-tag-text: var(--light-color-text); + --light-color-comment-tag: var(--light-color-background); + + --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: #4d7fff; + --light-color-ts-property: #ff984d; + --light-color-ts-method: #ff4db8; + --light-color-ts-reference: #ff4d82; + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: #ff4d4d; + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-icon-text: var(--dark-color-text); + + --dark-color-comment-tag-text: var(--dark-color-text); + --dark-color-comment-tag: var(--dark-color-background); + + --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: #4d7fff; + --dark-color-ts-property: #ff984d; + --dark-color-ts-method: #ff4db8; + --dark-color-ts-reference: #ff4d82; + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: #ff4d4d; + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + + --color-icon-background: var(--light-color-icon-background); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + + --color-icon-background: var(--dark-color-icon-background); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +*:focus-visible, +.tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} +footer > p { + margin: 0 1em; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} +a.tsd-anchor-link { + color: var(--color-text); +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; +} + +.tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; +} + +.tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-navigation .tsd-nav-link { + display: none; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-page-navigation-section { + margin-left: 10px; +} +.tsd-page-navigation-section > summary { + padding: 0.25rem; +} +.tsd-page-navigation-section > div { + margin-left: 20px; +} +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; + vertical-align: text-top; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-no-select { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} +.tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; +} +.tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-reference { + color: var(--color-ts-reference); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/docs/functions/Function_Integration.Merge.html b/docs/functions/Function_Integration.Merge.html new file mode 100644 index 00000000..9687b542 --- /dev/null +++ b/docs/functions/Function_Integration.Merge.html @@ -0,0 +1 @@ +Merge | astro-critters - v2.2.1

Function Merge

  • Merge<Ts>(...objects): DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
        DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

  • Type Parameters

    • Ts extends readonly unknown[]

    Parameters

    • Rest...objects: Ts

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
        DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

Settings

Member Visibility
diff --git a/docs/functions/Function_Integration.integration.html b/docs/functions/Function_Integration.integration.html new file mode 100644 index 00000000..084129bf --- /dev/null +++ b/docs/functions/Function_Integration.integration.html @@ -0,0 +1 @@ +integration | astro-critters - v2.2.1

Function integration

Settings

Member Visibility
diff --git a/docs/functions/Merge.merge.html b/docs/functions/Merge.merge.html new file mode 100644 index 00000000..2bd28bad --- /dev/null +++ b/docs/functions/Merge.merge.html @@ -0,0 +1 @@ +merge | astro-critters - v2.2.1

Function merge

  • merge<Ts>(...objects): DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
        DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

  • Type Parameters

    • Ts extends readonly unknown[]

    Parameters

    • Rest...objects: Ts

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
        DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..7dd2f2d7 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,79 @@ +astro-critters - v2.2.1

astro-critters - v2.2.1

Astro

Related —

Build
Dependency
Version
Star
Download
🗜️ Compress —		 Build
Dependency
Version
Star
Download
🗻 Format —
+

🦔 Inline —

This Astro integration brings critters to +your Astro project.

+

Critters is a plugin that inlines your app's critical CSS and lazy-loads the rest.

+
+

Note

+

Inline will not inline your requests, only your statically generated build +and pre-rendered routes.

+
+

🚀 Installation

There are two ways to add integrations to your project. Let's try the most +convenient option first!

+

astro add command

Astro includes a CLI tool for adding first party integrations: astro add. This +command will:

+
    +
  1. (Optionally) Install all necessary dependencies and peer dependencies
    2. +
  2. (Also optionally) Update your astro.config.* file to apply this integration
    3. +
+

To install Inline, run the following from your project directory and follow +the prompts:

+

Using NPM:

+
npx astro add astro-critters
+
+ +

Using Yarn:

+
yarn astro add astro-critters
+
+ +

Using PNPM:

+
pnpx astro add astro-critters
+
+ +

Install dependencies manually

First, install the Inline integration like so:

+
npm install -D -E astro-critters
+
+ +

Then, apply this integration to your astro.config.* file using the +integrations property:

+
export default {
	integrations: [(await import("astro-critters")).default()],
};
+
+ +

Getting started

Critters will now automatically inline the critical CSS of your HTML files.

+

Default Inlining

You can override any of the default options from the configuration of:

+ +

or disable them entirely:

+
export default {
	integrations: [
		(await import("astro-critters")).default({
			Critters: false,
		}),
	],
};
+
+ +

Add Multiple Paths

You can add multiple paths to inline by specifying an array as the Path +variable.

+

astro.config.ts

+
export default {
	integrations: [
		(await import("astro-critters")).default({
			Path: ["./Target", "./Build"],
		}),
	],
};
+
+ +

Input-Output Mapping

You can also provide a map of paths for different input output directories.

+

astro.config.ts

+
export default {
	integrations: [
		(await import("astro-critters")).default({
			Path: new Map([["./Source", "./Target"]]),
		}),
	],
};
+
+ +

Or an array of the two.

+

astro.config.ts

+
export default {
	integrations: [
		(await import("astro-critters")).default({
			Path: [
				// Inline Target
				"./Target",
				// Inline Target one more time into a different directory
				new Map([["./Target", "./TargetInline"]]),
			],
		}),
	],
};
+
+ +

File Filtering

You can filter files to exclude specific ones from inlining. A filter can be an +array of regular expressions or a single match. You can also use functions to +match on file names:

+

astro.config.ts

+
export default {
	integrations: [
		(await import("astro-critters")).default({
			Exclude: [
				"File.html",
				(File: string) => File === "./Target/index.html",
			],
		}),
	],
};
+
+ +

Controlling Logging

You can control the logging level by setting the Logger parameter. The default +value is 2, but you can set it to 0 if you don't want to see debug messages:

+
export default {
	integrations: [
		(await import("astro-critters")).default({
			Logger: 0,
		}),
	],
};
+
+ +

Changelog

See CHANGELOG.md for a history of changes to this integration.

+

Settings

Member Visibility

On This Page

🦔 Inline —
diff --git a/docs/interfaces/Critters.Interface.html b/docs/interfaces/Critters.Interface.html new file mode 100644 index 00000000..73574ae3 --- /dev/null +++ b/docs/interfaces/Critters.Interface.html @@ -0,0 +1,6 @@ +Interface | astro-critters - v2.2.1

Interface Interface

interface Interface {
    debug?: ((message: string) => void);
    error?: ((message: string) => void);
    info?: ((message: string) => void);
    trace?: ((message: string) => void);
    warn?: ((message: string) => void);
}

Properties

debug? +error? +info? +trace? +warn? +

Properties

Optionaldebug

debug?: ((message: string) => void)

Optionalerror

error?: ((message: string) => void)

Optionalinfo

info?: ((message: string) => void)

Optionaltrace

trace?: ((message: string) => void)

Optionalwarn

warn?: ((message: string) => void)

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Interface_Critters.Interface.html b/docs/interfaces/Interface_Critters.Interface.html new file mode 100644 index 00000000..dd8d5c98 --- /dev/null +++ b/docs/interfaces/Interface_Critters.Interface.html @@ -0,0 +1,19 @@ +Interface | astro-critters - v2.2.1

Interface Interface

interface Interface {
    additionalStylesheets?: string[];
    compress?: boolean;
    external?: boolean;
    fonts?: boolean;
    inlineFonts?: boolean;
    inlineThreshold?: number;
    keyframes?: string;
    logger?: Interface;
    logLevel?:
        | "info"
        | "warn"
        | "error"
        | "trace"
        | "debug"
        | "silent";
    mergeStylesheets?: boolean;
    minimumExternalSize?: number;
    noscriptFallback?: boolean;
    path?: string;
    preload?:
        | "body"
        | "media"
        | "swap"
        | "js"
        | "js-lazy";
    preloadFonts?: boolean;
    pruneSource?: boolean;
    publicPath?: string;
    reduceInlineStyles?: boolean;
}

Properties

additionalStylesheets? +compress? +external? +fonts? +inlineFonts? +inlineThreshold? +keyframes? +logger? +logLevel? +mergeStylesheets? +minimumExternalSize? +noscriptFallback? +path? +preload? +preloadFonts? +pruneSource? +publicPath? +reduceInlineStyles? +

Properties

OptionaladditionalStylesheets

additionalStylesheets?: string[]

Optionalcompress

compress?: boolean

Optionalexternal

external?: boolean

Optionalfonts

fonts?: boolean

OptionalinlineFonts

inlineFonts?: boolean

OptionalinlineThreshold

inlineThreshold?: number

Optionalkeyframes

keyframes?: string

Optionallogger

logger?: Interface

OptionallogLevel

logLevel?:
    | "info"
    | "warn"
    | "error"
    | "trace"
    | "debug"
    | "silent"

OptionalmergeStylesheets

mergeStylesheets?: boolean

OptionalminimumExternalSize

minimumExternalSize?: number

OptionalnoscriptFallback

noscriptFallback?: boolean

Optionalpath

path?: string

Optionalpreload

preload?:
    | "body"
    | "media"
    | "swap"
    | "js"
    | "js-lazy"

OptionalpreloadFonts

preloadFonts?: boolean

OptionalpruneSource

pruneSource?: boolean

OptionalpublicPath

publicPath?: string

OptionalreduceInlineStyles

reduceInlineStyles?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Interface_Integration.Interface.html b/docs/interfaces/Interface_Integration.Interface.html new file mode 100644 index 00000000..99a17f5d --- /dev/null +++ b/docs/interfaces/Interface_Integration.Interface.html @@ -0,0 +1 @@ +Interface | astro-critters - v2.2.1

Interface Interface

Settings

Member Visibility
diff --git a/docs/interfaces/Interface_Option.Interface.html b/docs/interfaces/Interface_Option.Interface.html new file mode 100644 index 00000000..fd24814a --- /dev/null +++ b/docs/interfaces/Interface_Option.Interface.html @@ -0,0 +1,23 @@ +Interface | astro-critters - v2.2.1

Interface Interface

interface Interface {
    Action?: boolean | Interface;
    Cache?: boolean | Interface;
    Critters?: boolean | Interface;
    Exclude?:
        | boolean
        | Type
        | Type[]
        | Set<Type>;
    File?: string | boolean | string[];
    Logger?: boolean | Type;
    Path?:
        | boolean
        | Type
        | Type[]
        | Set<Type>;
}

Hierarchy

  • default
    • Interface

Properties

Action? +Cache? +Critters? +Exclude? +File? +Logger? +Path? +

Properties

OptionalAction

Action?: boolean | Interface

Action pipe configuration.

+

OptionalCache

Cache?: boolean | Interface

Configuration for the target cache.

+

Default

{ Search: "./", Folder: "./Cache" }
+
+ +

OptionalCritters

Critters?: boolean | Interface

OptionalExclude

Exclude?:
    | boolean
    | Type
    | Type[]
    | Set<Type>

Criteria for excluding files.

+

OptionalFile

File?: string | boolean | string[]

File patterns to be matched.

+

OptionalLogger

Logger?: boolean | Type

Debugging level.

+

Default

2
+
+ +

OptionalPath

Path?:
    | boolean
    | Type
    | Type[]
    | Set<Type>

Configuration for the target path(s).

+

Default

"./Target"
+
+ +

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/media/CHANGELOG.md b/docs/media/CHANGELOG.md new file mode 100644 index 00000000..6df0345c --- /dev/null +++ b/docs/media/CHANGELOG.md @@ -0,0 +1,373 @@ +## 2.2.1 + +#### Changed + +- Updated the version in `package.json` from `2.2.0` to `2.2.1`. +- Updated email and URL in `package.json` to use the `.LTD` domain. +- Updated dependencies in `package.json`: + - `@playform/pipe` from `0.1.0` to `0.1.2` + - `critters` from `0.0.2`4 to `0.0.2`5 + - Added `deepmerge-ts` version `7.1.3` + - `@playform/build` from `0.1.2` to `0.2.1` + +#### Added + +- Added `DEPENDENTS.md` and `docs/` to `.npmignore`. +- Added type imports in `Source/Function/Integration.ts` for `Action`, `Path`, + and `Interface`. +- Added type imports in `Source/Interface/Critters.ts` for `Logger`. +- Added type imports in `Source/Interface/Integration.ts` for `AstroIntegration` + and `Option`. +- Added type imports in `Source/Interface/Option.ts` for `Option` and + `Critters`. +- Added type imports in `Source/Variable/Critters.ts` for `Interface`. +- Added type imports in `Source/Variable/Option.ts` for `Interface`. + +#### Fixed + +- Modified `Integration.ts` to handle `Path` as an instance of `Map`. + +#### Removed + +- Removed redundant imports in various files. + +## 2.2.0 + +### Changed + +- Updated `@playform/pipe` from `0.0.5` to `0.1.0`. +- Updated `critters` from `0.0.22` to `0.0.24`. +- Updated `@playform/build` from `0.0.10` to `0.1.2`. +- Added `provenance` field in `package.json`. + +### Added + +- Added `reduceInlineStyles` option in `Critters.ts`. + +## 2.1.10 + +- Cleanup + +## 2.1.9 + +- Cleanup + +## 2.1.8 + +- Cleanup + +## 2.1.7 + +- Cleanup + +## 2.1.6 + +- Cleanup + +## 2.1.5 + +- Cleanup + +## 2.1.4 + +- Cleanup + +## 2.1.3 + +- Cleanup + +## 2.1.2 + +- Cleanup +- Bug fix + +## 2.1.1 + +- Cleanup + +## 2.1.0 + +- Refactor +- Documentation + +## 2.0.1` + +- Cleanup + +## 2.0.1` + +- Cleanup + +## 2.0.9 + +- Cleanup + +## 2.0.8 + +- Cleanup + +## 2.0.7 + +- Cleanup + +## 2.0.6 + +- Cleanup + +## 2.0.5 + +- Cleanup + +## 2.0.4 + +- Cleanup + +## 2.0.3 + +- Cleanup + +## 2.0.2 + +- Cleanup + +## 2.0.1 + +- Restoration + +## 1.1.4` + +- Cleanup + +## 1.1.3` + +- Bug fix + +## 1.1.3` + +- Bug fix + +## 1.1.3` + +- Bug fix + +## 1.1.3` + +- Cleanup + +## 1.1.3` + +- Cleanup + +## 1.1.3` + +- Bug fix + +## 1.1.3` + +- Version with provenance + +## 1.1.3` + +- Cleanup + +## 1.1.3` + +- Switches to the files-pipe component + +## 1.1.3` + +- Updates files-pipeline component + +## 1.1.2` + +- Enhancement + +## 1.1.2` + +- Bug fix + +## 1.1.2` + +- Cleanup + +## 1.1.2` + +- Bug fix + +## 1.1.2` + +- Cleanup + +## 1.1.2` + +- Cleanup + +## 1.1.2` + +- Switches ownership + +## 1.1.2` + +- Cleanup + +## 1.1.2` + +- Bug fix + +## 1.1.2` + +- Cleanup + +## 1.1.1` + +- Bug fix + +## 1.1.1` + +- Updates pipeline + +## 1.1.1` + +- Bug fix + +## 1.1.1` + +- Refactor + +## 1.1.1` + +- Adds missing types + +## 1.1.1` + +- Adapt + +## 1.1.1` + +- Bug fix + +## 1.1.1` + +- Cleanup + +## 1.1.1` + +- Bug fix + +## 1.1.1` + +- Cleanup + +## 1.1.9 + +- Bug fix + +## 1.1.8 + +- Cleanup + +## 1.1.7 + +- Cleanup + +## 1.1.6 + +- Cleanup + +## 1.1.5 + +- Cleanup + +## 1.1.4 + +- Adds multiple paths + +## 1.1.3 + +- Bug fix + +## 1.1.2 + +- Switches to media preloading + +## 1.1.1 + +- Cleanup + +## 1.1.0 + +- Introduces filters + +## 1.0.5 + +- Switches ownership + +## 1.0.4 + +- Enhancement + +## 1.0.3 + +- Cleanup + +## 1.0.2 + +- Refactor + +## 1.0.1 + +- Bug fix + +## 1.0.0 + +- First stable version + +## 0.0.1` + +- Refactor + +## 0.0.1` + +- Cleanup + +## 0.0.9 + +- Updates dependencies + +## 0.0.8 + +- Refactor + +## 0.0.7 + +- Updates package.json +- Updates README.md +- Minify + +## 0.0.6 + +- Updates package.json +- Updates README.md +- Refactor + +## 0.0.5 + +- Updates README.md + +## 0.0.4 + +- Updates README.md +- Refactor + +## 0.0.3 + +- Adds hedgehog + +## 0.0.2 + +- Provides a CHANGELOG.md +- Adds typescript to devDependencies + +## 0.0.1 + +- Initial version diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 00000000..ddcc55cf --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,9 @@ +astro-critters - v2.2.1

astro-critters - v2.2.1

Index

Modules

Critters +Function/Integration +Interface/Critters +Interface/Integration +Interface/Option +Merge +Variable/Critters +Variable/Option +

Settings

Member Visibility
diff --git a/docs/modules/Critters.html b/docs/modules/Critters.html new file mode 100644 index 00000000..cbc0a26c --- /dev/null +++ b/docs/modules/Critters.html @@ -0,0 +1,2 @@ +Critters | astro-critters - v2.2.1

Module Critters

Index

Interfaces

Interface +

Settings

Member Visibility
diff --git a/docs/modules/Function_Integration.html b/docs/modules/Function_Integration.html new file mode 100644 index 00000000..a84f03ad --- /dev/null +++ b/docs/modules/Function_Integration.html @@ -0,0 +1,5 @@ +Function/Integration | astro-critters - v2.2.1

Module Function/Integration

Index

Variables

Default +Search +

Functions

integration +Merge +

Settings

Member Visibility
diff --git a/docs/modules/Interface_Critters.html b/docs/modules/Interface_Critters.html new file mode 100644 index 00000000..9d98eea0 --- /dev/null +++ b/docs/modules/Interface_Critters.html @@ -0,0 +1,2 @@ +Interface/Critters | astro-critters - v2.2.1

Module Interface/Critters

Index

Interfaces

Interface +

Settings

Member Visibility
diff --git a/docs/modules/Interface_Integration.html b/docs/modules/Interface_Integration.html new file mode 100644 index 00000000..59624c5f --- /dev/null +++ b/docs/modules/Interface_Integration.html @@ -0,0 +1,2 @@ +Interface/Integration | astro-critters - v2.2.1

Module Interface/Integration

Index

Interfaces

Interface +

Settings

Member Visibility
diff --git a/docs/modules/Interface_Option.html b/docs/modules/Interface_Option.html new file mode 100644 index 00000000..6b780f82 --- /dev/null +++ b/docs/modules/Interface_Option.html @@ -0,0 +1,2 @@ +Interface/Option | astro-critters - v2.2.1

Module Interface/Option

Index

Interfaces

Interface +

Settings

Member Visibility
diff --git a/docs/modules/Merge.html b/docs/modules/Merge.html new file mode 100644 index 00000000..817db8f6 --- /dev/null +++ b/docs/modules/Merge.html @@ -0,0 +1,2 @@ +Merge | astro-critters - v2.2.1

Module Merge

Index

Functions

merge +

Settings

Member Visibility
diff --git a/docs/modules/Variable_Critters.html b/docs/modules/Variable_Critters.html new file mode 100644 index 00000000..e7e6700a --- /dev/null +++ b/docs/modules/Variable_Critters.html @@ -0,0 +1,2 @@ +Variable/Critters | astro-critters - v2.2.1

Module Variable/Critters

Index

Variables

critters +

Settings

Member Visibility
diff --git a/docs/modules/Variable_Option.html b/docs/modules/Variable_Option.html new file mode 100644 index 00000000..00530886 --- /dev/null +++ b/docs/modules/Variable_Option.html @@ -0,0 +1,2 @@ +Variable/Option | astro-critters - v2.2.1

Module Variable/Option

Index

Variables

option +

Settings

Member Visibility
diff --git a/docs/variables/Function_Integration.Default.html b/docs/variables/Function_Integration.Default.html new file mode 100644 index 00000000..72148b85 --- /dev/null +++ b/docs/variables/Function_Integration.Default.html @@ -0,0 +1 @@ +Default | astro-critters - v2.2.1

Variable Default

Default: {
    Action: {
        Accomplished: false;
        Changed: ((Plan: Interface) => Promise<Interface>);
        Failed: ((On: Interface) => Promise<string>);
        Fulfilled: ((__namedParameters: Interface) => Promise<string | false>);
        Passed: ((On: Interface) => Promise<true>);
        Read: ((__namedParameters: Interface) => Promise<string>);
        Wrote: ((__namedParameters: Interface) => Promise<Type>);
    };
    Cache: {
        Folder: string;
        Search: string;
    };
    Critters: Interface;
    Exclude: false;
    File: string;
    Logger: 2;
    Path: string;
}

Settings

Member Visibility
diff --git a/docs/variables/Function_Integration.Search.html b/docs/variables/Function_Integration.Search.html new file mode 100644 index 00000000..cf279019 --- /dev/null +++ b/docs/variables/Function_Integration.Search.html @@ -0,0 +1 @@ +Search | astro-critters - v2.2.1

Variable Search

Search: string

Settings

Member Visibility
diff --git a/docs/variables/Variable_Critters.critters.html b/docs/variables/Variable_Critters.critters.html new file mode 100644 index 00000000..e0437256 --- /dev/null +++ b/docs/variables/Variable_Critters.critters.html @@ -0,0 +1 @@ +critters | astro-critters - v2.2.1

Variable critters

critters: Interface

Settings

Member Visibility
diff --git a/docs/variables/Variable_Option.option.html b/docs/variables/Variable_Option.option.html new file mode 100644 index 00000000..5830b274 --- /dev/null +++ b/docs/variables/Variable_Option.option.html @@ -0,0 +1 @@ +option | astro-critters - v2.2.1

Variable option

option: {
    Action: {
        Accomplished: false;
        Changed: ((Plan: Interface) => Promise<Interface>);
        Failed: ((On: Interface) => Promise<string>);
        Fulfilled: ((__namedParameters: Interface) => Promise<string | false>);
        Passed: ((On: Interface) => Promise<true>);
        Read: ((__namedParameters: Interface) => Promise<string>);
        Wrote: ((__namedParameters: Interface) => Promise<Type>);
    };
    Cache: {
        Folder: string;
        Search: string;
    };
    Critters: Interface;
    Exclude: false;
    File: string;
    Logger: 2;
    Path: string;
}

Settings

Member Visibility