Leahnaya/asphyxia-core.github.io
1
0
Fork 0
mirror of https://github.com/asphyxia-core/asphyxia-core.github.io.git synced 2026-03-21 17:25:23 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

v1.20 documentation

Browse Source
This commit is contained in:
Freddie Wang 2020-12-11 13:51:31 +08:00
parent b42e70c18a
commit 06aadd6e05
13 changed files with 224 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
typedoc/assets/js/search.json
View File

File diff suppressed because one or more lines are too long

52
typedoc/classes/kdatareader.html
View File

@ -67,7 +67,7 @@
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A warpper of javascript object for reading xml-like formatted data.</p>
<p>A wrapper of javascript object for reading xml-like formatted data.</p>
</div>
</div>
</section>
@ -126,7 +126,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:336</li>
<li>Defined in asphyxia-core.d.ts:340</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -148,7 +148,7 @@
<div class="tsd-signature tsd-kind-icon">obj<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:336</li>
<li>Defined in asphyxia-core.d.ts:340</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -170,12 +170,12 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:369</li>
<li>Defined in asphyxia-core.d.ts:373</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get attrubutes for a tag</p>
<p>Get attributes for a tag</p>
</div>
<p>Example:</p>
<pre><code class="language-xml"><span class="hljs-tag">&lt;<span class="hljs-name">data</span>&gt;</span>
@ -192,7 +192,7 @@
]
})
}</code></pre>
<p>Evals:</p>
<p>Eval:</p>
<pre><code class="language-javascript">$(data).attr(<span class="hljs-string">&quot;tag&quot;</span>) <span class="hljs-comment">// { status: &quot;1&quot; }</span>
$(data).element(<span class="hljs-string">&quot;tag&quot;</span>).attr().status <span class="hljs-comment">// &quot;1&quot;</span>
$(data).attr(<span class="hljs-string">&quot;tag.inner.0&quot;</span>).__type <span class="hljs-comment">// &quot;s32&quot;</span></code></pre>
@ -217,7 +217,7 @@ $(data).attr(<span class="hljs-string">&quot;tag.inner.0&quot;</span>).__type <s
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:402</li>
<li>Defined in asphyxia-core.d.ts:406</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -237,7 +237,7 @@ $(data).attr(<span class="hljs-string">&quot;tag.inner.0&quot;</span>).__type <s
],
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">&quot;str&quot;</span>, <span class="hljs-string">&quot;abc&quot;</span>)
}</code></pre>
<p>Evals:</p>
<p>Eval:</p>
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">&quot;inner&quot;</span>).bigint() <span class="hljs-comment">// 1n</span>
$(data).bigint(<span class="hljs-string">&quot;inner.1&quot;</span>) <span class="hljs-comment">// 2n</span>
$(data).bigint(<span class="hljs-string">&quot;invalid&quot;</span>, <span class="hljs-number">3n</span>) <span class="hljs-comment">// 3n</span></code></pre>
@ -269,7 +269,7 @@ $(data).bigint(<span class="hljs-string">&quot;invalid&quot;</span>, <span class
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:428</li>
<li>Defined in asphyxia-core.d.ts:432</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -286,7 +286,7 @@ $(data).bigint(<span class="hljs-string">&quot;invalid&quot;</span>, <span class
<span class="hljs-attr">inner</span>: K.ARRAY(<span class="hljs-string">&quot;s64&quot;</span>, [<span class="hljs-number">1n</span>, <span class="hljs-number">2n</span>]),
<span class="hljs-attr">invalid</span>: K.ARRAY(<span class="hljs-string">&quot;s32&quot;</span>, [<span class="hljs-number">3</span>, <span class="hljs-number">4</span>])
}</code></pre>
<p>Evals:</p>
<p>Eval:</p>
<pre><code class="language-javascript">$(data).bigints(<span class="hljs-string">&quot;inner&quot;</span>) <span class="hljs-comment">// [1n, 2n]</span>
$(data).bigints(<span class="hljs-string">&quot;invalid&quot;</span>) <span class="hljs-comment">// undefined</span></code></pre>
</div>
@ -313,7 +313,7 @@ $(data).bigints(<span class="hljs-string">&quot;invalid&quot;</span>) <span clas
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:456</li>
<li>Defined in asphyxia-core.d.ts:460</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -331,7 +331,7 @@ $(data).bigints(<span class="hljs-string">&quot;invalid&quot;</span>) <span clas
K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">2</span>)
]
}</code></pre>
<p>Evals:</p>
<p>Eval:</p>
<pre><code class="language-javascript">$(data).bool(<span class="hljs-string">&quot;inner.0&quot;</span>) <span class="hljs-comment">// false</span>
$(data).bool(<span class="hljs-string">&quot;inner.1&quot;</span>) <span class="hljs-comment">// true</span>
$(data).bool(<span class="hljs-string">&quot;invalid&quot;</span>) <span class="hljs-comment">// false</span></code></pre>
@ -356,7 +356,7 @@ $(data).bool(<span class="hljs-string">&quot;invalid&quot;</span>) <span class="
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:482</li>
<li>Defined in asphyxia-core.d.ts:486</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -373,7 +373,7 @@ $(data).bool(<span class="hljs-string">&quot;invalid&quot;</span>) <span class="
<span class="hljs-attr">inner</span>: K.ITEM(<span class="hljs-string">&quot;bin&quot;</span>, Buffer.from([<span class="hljs-number">0x00</span>, <span class="hljs-number">0xff</span>])),
<span class="hljs-attr">invalid</span>: K.ARRAY(<span class="hljs-string">&quot;u8&quot;</span>, [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>])
}</code></pre>
<p>Evals:</p>
<p>Eval:</p>
<pre><code class="language-javascript">$(data).buffer(<span class="hljs-string">&quot;inner&quot;</span>) <span class="hljs-comment">// &lt;Buffer 00 ff&gt;</span>
$(data).buffer(<span class="hljs-string">&quot;invalid&quot;</span>) <span class="hljs-comment">// undefined</span></code></pre>
</div>
@ -400,7 +400,7 @@ $(data).buffer(<span class="hljs-string">&quot;invalid&quot;</span>) <span class
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:510</li>
<li>Defined in asphyxia-core.d.ts:514</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -418,7 +418,7 @@ $(data).buffer(<span class="hljs-string">&quot;invalid&quot;</span>) <span class
<span class="hljs-attr">array</span>: K.ARRAY(<span class="hljs-string">&quot;u8&quot;</span>, [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]),
<span class="hljs-attr">string</span>: K.ITEM(<span class="hljs-string">&quot;str&quot;</span>, <span class="hljs-string">&quot;abc&quot;</span>)
}</code></pre>
<p>Evals:</p>
<p>Eval:</p>
<pre><code class="language-javascript">$(data).content(<span class="hljs-string">&quot;number&quot;</span>) <span class="hljs-comment">// [1]</span>
$(data).content(<span class="hljs-string">&quot;array&quot;</span>) <span class="hljs-comment">// [1, 2, 3]</span>
$(data).content(<span class="hljs-string">&quot;string&quot;</span>) <span class="hljs-comment">// &quot;abc&quot;</span></code></pre>
@ -446,7 +446,7 @@ $(data).content(<span class="hljs-string">&quot;string&quot;</span>) <span class
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:542</li>
<li>Defined in asphyxia-core.d.ts:546</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -468,7 +468,7 @@ $(data).content(<span class="hljs-string">&quot;string&quot;</span>) <span class
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">2</span>) }
]
}</code></pre>
<p>Evals:</p>
<p>Eval:</p>
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">&quot;inner&quot;</span>) <span class="hljs-comment">// &lt;KDataReader&gt;</span>
$(data).element(<span class="hljs-string">&quot;inner&quot;</span>).obj <span class="hljs-comment">// { id: [object] }</span>
$(data).element(<span class="hljs-string">&quot;inner&quot;</span>).number(<span class="hljs-string">&quot;id&quot;</span>) <span class="hljs-comment">// 1</span></code></pre>
@ -493,7 +493,7 @@ $(data).element(<span class="hljs-string">&quot;inner&quot;</span>).number(<span
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:573</li>
<li>Defined in asphyxia-core.d.ts:577</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -515,7 +515,7 @@ $(data).element(<span class="hljs-string">&quot;inner&quot;</span>).number(<span
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">2</span>) }
]
}</code></pre>
<p>Evals:</p>
<p>Eval:</p>
<pre><code class="language-javascript">$(data).elements(<span class="hljs-string">&quot;inner&quot;</span>) <span class="hljs-comment">// [&lt;KDataReader&gt;, &lt;KDataReader&gt;]</span>
$(data).elements(<span class="hljs-string">&quot;inner&quot;</span>)[<span class="hljs-number">1</span>].number(<span class="hljs-string">&quot;id&quot;</span>) <span class="hljs-comment">// 2</span></code></pre>
</div>
@ -539,7 +539,7 @@ $(data).elements(<span class="hljs-string">&quot;inner&quot;</span>)[<span class
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:606</li>
<li>Defined in asphyxia-core.d.ts:610</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -559,7 +559,7 @@ $(data).elements(<span class="hljs-string">&quot;inner&quot;</span>)[<span class
],
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">&quot;str&quot;</span>, <span class="hljs-string">&quot;abc&quot;</span>)
}</code></pre>
<p>Evals:</p>
<p>Eval:</p>
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">&quot;inner&quot;</span>).number() <span class="hljs-comment">// 1</span>
$(data).number(<span class="hljs-string">&quot;inner.1&quot;</span>) <span class="hljs-comment">// 2</span>
$(data).number(<span class="hljs-string">&quot;invalid&quot;</span>, <span class="hljs-number">3</span>) <span class="hljs-comment">// 3</span></code></pre>
@ -591,7 +591,7 @@ $(data).number(<span class="hljs-string">&quot;invalid&quot;</span>, <span class
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:632</li>
<li>Defined in asphyxia-core.d.ts:636</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -608,7 +608,7 @@ $(data).number(<span class="hljs-string">&quot;invalid&quot;</span>, <span class
<span class="hljs-attr">invalid</span>: K.ARRAY(<span class="hljs-string">&quot;s64&quot;</span>, [<span class="hljs-number">1n</span>, <span class="hljs-number">2n</span>]),
<span class="hljs-attr">inner</span>: K.ARRAY(<span class="hljs-string">&quot;s32&quot;</span>, [<span class="hljs-number">3</span>, <span class="hljs-number">4</span>])
}</code></pre>
<p>Evals:</p>
<p>Eval:</p>
<pre><code class="language-javascript">$(data).bigints(<span class="hljs-string">&quot;invalid&quot;</span>) <span class="hljs-comment">// undefined</span>
$(data).bigints(<span class="hljs-string">&quot;inner&quot;</span>) <span class="hljs-comment">// [3, 4]</span></code></pre>
</div>
@ -635,7 +635,7 @@ $(data).bigints(<span class="hljs-string">&quot;inner&quot;</span>) <span class=
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:658</li>
<li>Defined in asphyxia-core.d.ts:662</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -652,7 +652,7 @@ $(data).bigints(<span class="hljs-string">&quot;inner&quot;</span>) <span class=
<span class="hljs-attr">inner</span>: K.ITEM(<span class="hljs-string">&quot;str&quot;</span>, <span class="hljs-string">&quot;abc&quot;</span>),
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">1</span>)
}</code></pre>
<p>Evals:</p>
<p>Eval:</p>
<pre><code class="language-javascript">$(data).str(<span class="hljs-string">&quot;inner&quot;</span>) <span class="hljs-comment">// &quot;abc&quot;</span>
$(data).str(<span class="hljs-string">&quot;invalid&quot;</span>) <span class="hljs-comment">// undefined</span></code></pre>
</div>

4
typedoc/index.html
View File

@ -124,7 +124,7 @@
<div class="tsd-signature tsd-kind-icon">EPR<span class="tsd-signature-symbol">:</span> <a href="index.html#eamusepluginroute" class="tsd-signature-type">EamusePluginRoute</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:247</li>
<li>Defined in asphyxia-core.d.ts:251</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -140,7 +140,7 @@
<div class="tsd-signature tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="interfaces/eamuseinfo.html" class="tsd-signature-type">EamuseInfo</a>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, send<span class="tsd-signature-symbol">: </span><a href="interfaces/eamusesend.html" class="tsd-signature-type">EamuseSend</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:240</li>
<li>Defined in asphyxia-core.d.ts:244</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

2
typedoc/interfaces/configoption.html
View File

@ -142,7 +142,7 @@
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Provide a name to display in webui. If not provided, webui will use key as the name.</p>
<p>Provide a name to display in WebUI. If not provided, WebUI will use key as the name.</p>
</div>
</div>
</section>

20
typedoc/interfaces/eamusesend.html
View File

@ -100,7 +100,7 @@
<div class="tsd-signature tsd-kind-icon">deny<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:161</li>
<li>Defined in asphyxia-core.d.ts:165</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -136,7 +136,7 @@
<div class="tsd-signature tsd-kind-icon">object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:194</li>
<li>Defined in asphyxia-core.d.ts:198</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -144,14 +144,14 @@
<p>Send plain javascript object.
When constructing objects, make sure to use helper <a href="../modules/k.html">K</a>:</p>
<pre><code>{
<span class="hljs-attribute">outter</span>: K.<span class="hljs-built_in">ATTR</span>({ status: <span class="hljs-string">&quot;1&quot;</span> }, {
<span class="hljs-attribute">outer</span>: K.<span class="hljs-built_in">ATTR</span>({ status: <span class="hljs-string">&quot;1&quot;</span> }, {
inner: K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">1</span>)
})
}</code></pre>
</div>
<p>Or follow xml-like format manually:</p>
<pre><code>{
outter: {
outer: {
<span class="hljs-string">&quot;@attr&quot;</span>: { status: <span class="hljs-string">&quot;1&quot;</span> },
inner: {
<span class="hljs-string">&quot;@attr&quot;</span>: { __type: <span class="hljs-string">&quot;s32&quot;</span> },
@ -199,7 +199,7 @@
<div class="tsd-signature tsd-kind-icon">pug<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:214</li>
<li>Defined in asphyxia-core.d.ts:218</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -253,7 +253,7 @@
<div class="tsd-signature tsd-kind-icon">pug<wbr>File<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:234</li>
<li>Defined in asphyxia-core.d.ts:238</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -307,7 +307,7 @@
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:166</li>
<li>Defined in asphyxia-core.d.ts:170</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -346,7 +346,7 @@
<div class="tsd-signature tsd-kind-icon">success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:156</li>
<li>Defined in asphyxia-core.d.ts:160</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -382,7 +382,7 @@
<div class="tsd-signature tsd-kind-icon">xml<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:204</li>
<li>Defined in asphyxia-core.d.ts:208</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -436,7 +436,7 @@
<div class="tsd-signature tsd-kind-icon">xml<wbr>File<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:224</li>
<li>Defined in asphyxia-core.d.ts:228</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

12
typedoc/interfaces/eamusesendoption.html
View File

@ -105,7 +105,7 @@
<div class="tsd-signature tsd-kind-icon">compress<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:147</li>
<li>Defined in asphyxia-core.d.ts:151</li>
</ul>
</aside>
</section>
@ -115,7 +115,7 @@
<div class="tsd-signature tsd-kind-icon">encoding<span class="tsd-signature-symbol">:</span> <a href="../index.html#kencoding" class="tsd-signature-type">KEncoding</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:138</li>
<li>Defined in asphyxia-core.d.ts:142</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -131,7 +131,7 @@
<div class="tsd-signature tsd-kind-icon">encrypt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:149</li>
<li>Defined in asphyxia-core.d.ts:153</li>
</ul>
</aside>
</section>
@ -141,7 +141,7 @@
<div class="tsd-signature tsd-kind-icon">kencode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:148</li>
<li>Defined in asphyxia-core.d.ts:152</li>
</ul>
</aside>
</section>
@ -151,7 +151,7 @@
<div class="tsd-signature tsd-kind-icon">root<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:145</li>
<li>Defined in asphyxia-core.d.ts:149</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -168,7 +168,7 @@
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:132</li>
<li>Defined in asphyxia-core.d.ts:136</li>
</ul>
</aside>
</section>

9
typedoc/interfaces/fileoption.html
View File

@ -67,7 +67,7 @@
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Details of a datafile</p>
<p>Details of a data file</p>
</div>
</div>
</section>
@ -138,7 +138,7 @@
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Provide a name to display in webui. If not provided, webui will use filename as the label.</p>
<p>Provide a name to display in WebUI. If not provided, WebUI will use filename as the label.</p>
</div>
</div>
</section>
@ -148,13 +148,14 @@
<div class="tsd-signature tsd-kind-icon">required<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:125</li>
<li>Defined in asphyxia-core.d.ts:129</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Whether the file required for the plugin to work, defaults to false</p>
<p>Whether the file is required for the plugin to work, defaults to false.</p>
</div>
<p>Note that this only provides visual hint for the file in WebUI.</p>
</div>
</section>
</section>

24
typedoc/modules/_.html
View File

@ -73,7 +73,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:664</li>
<li>Defined in asphyxia-core.d.ts:668</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -126,7 +126,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:666</li>
<li>Defined in asphyxia-core.d.ts:670</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -152,7 +152,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:667</li>
<li>Defined in asphyxia-core.d.ts:671</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -181,7 +181,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:668</li>
<li>Defined in asphyxia-core.d.ts:672</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -210,7 +210,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:669</li>
<li>Defined in asphyxia-core.d.ts:673</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -236,7 +236,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:670</li>
<li>Defined in asphyxia-core.d.ts:674</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -265,7 +265,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:671</li>
<li>Defined in asphyxia-core.d.ts:675</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -294,7 +294,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:672</li>
<li>Defined in asphyxia-core.d.ts:676</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -323,7 +323,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:673</li>
<li>Defined in asphyxia-core.d.ts:677</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -352,7 +352,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:674</li>
<li>Defined in asphyxia-core.d.ts:678</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -381,7 +381,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:675</li>
<li>Defined in asphyxia-core.d.ts:679</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -410,7 +410,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:676</li>
<li>Defined in asphyxia-core.d.ts:680</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>

30
typedoc/modules/db.html
View File

@ -76,7 +76,7 @@
<p>If <code>refid</code> is not provided, query will match data in <strong><em>PluginSpace</em></strong>.</p>
<hr>
<p><strong>NOTE</strong>: since WebUI can delete data in <strong>ProfileSpace</strong>,
you should refrain from referencing refid in your document to prevent getting unclearable garbage data.</p>
you should refrain from referencing refid in your document to prevent getting residual garbage data.</p>
<p>If you need to make rival/friend feature, we recommend you to get all profile data by passing null to <code>refid</code>.
There will be 16 profiles maximum which is small enough to manage.</p>
<p>All query and doc should not have any fields start with <code>__</code> while <code>__refid</code> being the only exception.
@ -115,7 +115,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1069</li>
<li>Defined in asphyxia-core.d.ts:1105</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -138,7 +138,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1070</li>
<li>Defined in asphyxia-core.d.ts:1106</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -168,7 +168,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1026</li>
<li>Defined in asphyxia-core.d.ts:1062</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -191,7 +191,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1027</li>
<li>Defined in asphyxia-core.d.ts:1063</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -221,7 +221,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1023</li>
<li>Defined in asphyxia-core.d.ts:1059</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -244,7 +244,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1024</li>
<li>Defined in asphyxia-core.d.ts:1060</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -274,7 +274,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1029</li>
<li>Defined in asphyxia-core.d.ts:1065</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -297,7 +297,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1030</li>
<li>Defined in asphyxia-core.d.ts:1066</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -327,7 +327,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1032</li>
<li>Defined in asphyxia-core.d.ts:1068</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -350,7 +350,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1033</li>
<li>Defined in asphyxia-core.d.ts:1069</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -380,7 +380,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1035</li>
<li>Defined in asphyxia-core.d.ts:1071</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -406,7 +406,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1043</li>
<li>Defined in asphyxia-core.d.ts:1079</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -439,7 +439,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1051</li>
<li>Defined in asphyxia-core.d.ts:1087</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -465,7 +465,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1060</li>
<li>Defined in asphyxia-core.d.ts:1096</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>

71
typedoc/modules/io.html
View File

@ -82,6 +82,7 @@
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="io.html#exists" class="tsd-kind-icon">Exists</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="io.html#readdir" class="tsd-kind-icon">Read<wbr>Dir</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="io.html#readfile" class="tsd-kind-icon">Read<wbr>File</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="io.html#resolve" class="tsd-kind-icon">Resolve</a></li>
@ -93,6 +94,37 @@
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="exists" class="tsd-anchor"></a>
<h3>Exists</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">Exists<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:820</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Synchronously tests whether or not the given path exists by checking with the file system.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A path to a file or directory. If a URL is provided, it must use the file: protocol. URL support is experimental.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="readdir" class="tsd-anchor"></a>
<h3>Read<wbr>Dir</h3>
@ -103,7 +135,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:814</li>
<li>Defined in asphyxia-core.d.ts:826</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -128,16 +160,16 @@
<a name="readfile" class="tsd-anchor"></a>
<h3>Read<wbr>File</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">Read<wbr>File<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>encoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">Read<wbr>File<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>encoding<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">Read<wbr>File<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>encoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">Read<wbr>File<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">Read<wbr>File<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>encoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">Read<wbr>File<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>encoding<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">Read<wbr>File<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>encoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">Read<wbr>File<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:848</li>
<li>Defined in asphyxia-core.d.ts:862</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -159,15 +191,16 @@
<div class="tsd-comment tsd-typography">
<p>An object that may contain an optional flag.
If a flag is not provided, it defaults to <code>&#39;r&#39;</code>.</p>
<p>Returns null if any error occurs while reading a file</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:860</li>
<li>Defined in asphyxia-core.d.ts:876</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -189,15 +222,16 @@
<div class="tsd-comment tsd-typography">
<p>Either the encoding for the result, or an object that contains the encoding and an optional flag.
If a flag is not provided, it defaults to <code>&#39;r&#39;</code>.</p>
<p>Returns null if any error occurs while reading a file</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:872</li>
<li>Defined in asphyxia-core.d.ts:890</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -219,15 +253,16 @@
<div class="tsd-comment tsd-typography">
<p>Either the encoding for the result, or an object that contains the encoding and an optional flag.
If a flag is not provided, it defaults to <code>&#39;r&#39;</code>.</p>
<p>Returns null if any error occurs while reading a file</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:882</li>
<li>Defined in asphyxia-core.d.ts:902</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -242,10 +277,11 @@
<div class="tsd-comment tsd-typography">
<p>A path to a file.
If a file descriptor is provided, the underlying file will <em>not</em> be closed automatically.</p>
<p>Returns null if any error occurs while reading a file.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
@ -259,7 +295,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:808</li>
<li>Defined in asphyxia-core.d.ts:812</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -288,7 +324,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:827</li>
<li>Defined in asphyxia-core.d.ts:839</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -327,7 +363,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:839</li>
<li>Defined in asphyxia-core.d.ts:851</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -385,6 +421,9 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="io.html#exists" class="tsd-kind-icon">Exists</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="io.html#readdir" class="tsd-kind-icon">Read<wbr>Dir</a>
</li>

24
typedoc/modules/k.html
View File

@ -101,7 +101,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:789</li>
<li>Defined in asphyxia-core.d.ts:793</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -145,7 +145,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:790</li>
<li>Defined in asphyxia-core.d.ts:794</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -171,7 +171,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:791</li>
<li>Defined in asphyxia-core.d.ts:795</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -206,7 +206,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:748</li>
<li>Defined in asphyxia-core.d.ts:752</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -268,7 +268,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:765</li>
<li>Defined in asphyxia-core.d.ts:769</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -306,7 +306,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:766</li>
<li>Defined in asphyxia-core.d.ts:770</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -326,7 +326,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:767</li>
<li>Defined in asphyxia-core.d.ts:771</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -346,7 +346,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:768</li>
<li>Defined in asphyxia-core.d.ts:772</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -366,7 +366,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:769</li>
<li>Defined in asphyxia-core.d.ts:773</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -392,7 +392,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:770</li>
<li>Defined in asphyxia-core.d.ts:774</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -418,7 +418,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:771</li>
<li>Defined in asphyxia-core.d.ts:775</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -444,7 +444,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:772</li>
<li>Defined in asphyxia-core.d.ts:776</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>

14
typedoc/modules/r.html
View File

@ -103,7 +103,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:308</li>
<li>Defined in asphyxia-core.d.ts:312</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -141,7 +141,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:298</li>
<li>Defined in asphyxia-core.d.ts:302</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -179,7 +179,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:317</li>
<li>Defined in asphyxia-core.d.ts:321</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -216,7 +216,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:288</li>
<li>Defined in asphyxia-core.d.ts:292</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -249,7 +249,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:267</li>
<li>Defined in asphyxia-core.d.ts:271</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -291,7 +291,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:277</li>
<li>Defined in asphyxia-core.d.ts:281</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -324,7 +324,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:326</li>
<li>Defined in asphyxia-core.d.ts:330</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

75
typedoc/modules/u.html
View File

@ -79,7 +79,9 @@
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="u.html#card2nfc" class="tsd-kind-icon">Card2NFC</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="u.html#getconfig" class="tsd-kind-icon">Get<wbr>Config</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="u.html#nfc2card" class="tsd-kind-icon">NFC2<wbr>Card</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="u.html#parsexml" class="tsd-kind-icon">parseXML</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="u.html#toxml" class="tsd-kind-icon">toXML</a></li>
</ul>
@ -89,6 +91,38 @@
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="card2nfc" class="tsd-anchor"></a>
<h3>Card2NFC</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">Card2NFC<span class="tsd-signature-symbol">(</span>card<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:938</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert Card Number / Data Transfer Number to NFC serial</p>
</div>
<p>returns null if the card number is invalid</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>card: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Card Number / Data Transfer Number</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="getconfig" class="tsd-anchor"></a>
<h3>Get<wbr>Config</h3>
@ -99,7 +133,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:910</li>
<li>Defined in asphyxia-core.d.ts:930</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -119,6 +153,35 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="nfc2card" class="tsd-anchor"></a>
<h3>NFC2<wbr>Card</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">NFC2<wbr>Card<span class="tsd-signature-symbol">(</span>nfc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:946</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert NFC serial to Card Number or Data Transfer Number</p>
</div>
<p>returns null if the nfc serial is invalid</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>nfc: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="parsexml" class="tsd-anchor"></a>
<h3>parseXML</h3>
@ -129,7 +192,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:904</li>
<li>Defined in asphyxia-core.d.ts:924</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -166,7 +229,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:896</li>
<li>Defined in asphyxia-core.d.ts:916</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -217,9 +280,15 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="u.html#card2nfc" class="tsd-kind-icon">Card2NFC</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="u.html#getconfig" class="tsd-kind-icon">Get<wbr>Config</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="u.html#nfc2card" class="tsd-kind-icon">NFC2<wbr>Card</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="u.html#parsexml" class="tsd-kind-icon">parseXML</a>
</li>