Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Freddie Wang
|
664e7899aa | ||
|
Freddie Wang
|
06aadd6e05 | ||
|
Freddie Wang
|
b42e70c18a | ||
|
Freddie Wang
|
940921282b | ||
|
Freddie Wang
|
230869490f | ||
|
Freddie Wang
|
d4792b66de | ||
|
Freddie Wang
|
f84d82e636 | ||
|
Freddie Wang
|
7a106e5d2f | ||
|
Freddie Wang
|
d096ddb711 | ||
|
Freddie
|
8426673241 |
+2
-2
@@ -3,8 +3,8 @@ title: Asphyxia CORE
|
||||
logo: /img/core-logo.png
|
||||
description: |
|
||||
<ul class="downloads">
|
||||
<li><a href="#">Download <strong>CORE</strong></a></li>
|
||||
<li><a href="#">Setup <strong>Guides</strong></a></li>
|
||||
<li><a href="https://github.com/asphyxia-core/asphyxia-core.github.io/releases/latest">Download <strong>CORE</strong></a></li>
|
||||
<li><a href="https://github.com/asphyxia-core/plugins">Official <strong>Plugins</strong></a></li>
|
||||
<li><a href="typedoc">Developer <strong>Docs</strong></a></li>
|
||||
</ul>
|
||||
include:
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
#### Asphyxia CORE
|
||||
|
||||
Quick Start guide coming soon.
|
||||
@@ -1 +1,31 @@
|
||||
## Asphyxia
|
||||
This is a "e-amuse emulator".
|
||||
|
||||
## Features
|
||||
- Completely **offline**
|
||||
- Highly **customizable** with the plugin system
|
||||
- Supports **new** stuff and **old** stuff
|
||||
- **WebUI** configuration tool
|
||||
- Multiple profiles (up to **16** profiles)
|
||||
|
||||
## Setup Guide
|
||||
1. Download CORE
|
||||
2. Download Plugins
|
||||
3. Extract Plugins to the plugins folder
|
||||
4. Profit
|
||||
|
||||
## FAQ
|
||||
- Does it supports the X game?
|
||||
- Asphyxia CORE have no game support out of the box.
|
||||
- Please checkout the [community plugins](https://github.com/asphyxia-core/plugins) for game support or find some other plugins
|
||||
- Can I run Asphyxia on cabinets?
|
||||
- Asphyxia CORE can only ran on Windows 7 or newer, and we do not have any plans for Windows XP support.
|
||||
- Also, Asphyxia CORE is ram heavy. Depends on the plugins, it may takes up 60MB ~ 400MB of memory.
|
||||
- It is recommended to setup a dedicated small server box.
|
||||
- Can I have more than 16 profiles?
|
||||
- Well, that means you have more than 15 friends irl who have similar interests. Congratulations.
|
||||
- But unfortunately the profile limit is in place to prevent commercial or malicious usage. You can, for some additional effort, swap in and out your save files or use multiple instances of CORE.
|
||||
- Open-source?
|
||||
- The plugins are always open-source in nature.
|
||||
- As for the CORE: No. If you are asking for source code, you are not doing your research. (Although it is mainly because the code base is not in open-source quality.)
|
||||
- How do I make plugins?
|
||||
- Checkout our [Documentation](https://asphyxia-core.github.io/typedoc/) and maybe consider join our [Discord](https://discord.gg/3TW3BDm) server. Make sure to familiar yourself with at least XML and Typescript/Javascript.
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+133
-122
@@ -51,7 +51,7 @@
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="kdatareader.html">KDataReader</a>
|
||||
@@ -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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L317">asphyxia-core.d.ts:317</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L317">asphyxia-core.d.ts:317</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:340</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -164,38 +164,38 @@
|
||||
<a name="attr" class="tsd-anchor"></a>
|
||||
<h3>attr</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">attr<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><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">attr<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><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L350">asphyxia-core.d.ts:350</a></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"><<span class="hljs-name">data</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">tag</span> <span class="hljs-attr">status</span>=<span class="hljs-string">"1"</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>2<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">tag</span> <span class="hljs-attr">status</span>=<span class="hljs-string">"1"</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>2<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">tag</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">data</span>></span></code></pre>
|
||||
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
|
||||
<span class="hljs-attr">tag</span>: K.ATTR({ <span class="hljs-attr">status</span>: <span class="hljs-string">"1"</span> }, {
|
||||
<span class="hljs-attr">tag</span>: K.ATTR({ <span class="hljs-attr">status</span>: <span class="hljs-string">"1"</span> }, {
|
||||
<span class="hljs-attr">inner</span>: [
|
||||
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>),
|
||||
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>)
|
||||
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>),
|
||||
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>)
|
||||
]
|
||||
})
|
||||
}</code></pre>
|
||||
<p>Evals:</p>
|
||||
<pre><code class="language-javascript">$(data).attr(<span class="hljs-string">"tag"</span>) <span class="hljs-comment">// { status: "1" }</span>
|
||||
$(data).element(<span class="hljs-string">"tag"</span>).attr().status <span class="hljs-comment">// "1"</span>
|
||||
$(data).attr(<span class="hljs-string">"tag.inner.0"</span>).__type <span class="hljs-comment">// "s32"</span></code></pre>
|
||||
<p>Eval:</p>
|
||||
<pre><code class="language-javascript">$(data).attr(<span class="hljs-string">"tag"</span>) <span class="hljs-comment">// { status: "1" }</span>
|
||||
$(data).element(<span class="hljs-string">"tag"</span>).attr().status <span class="hljs-comment">// "1"</span>
|
||||
$(data).attr(<span class="hljs-string">"tag.inner.0"</span>).__type <span class="hljs-comment">// "s32"</span></code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -203,7 +203,7 @@ $(data).attr(<span class="hljs-string">"tag.inner.0"</span>).__type <span class=
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h4>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -217,7 +217,7 @@ $(data).attr(<span class="hljs-string">"tag.inner.0"</span>).__type <span class=
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L383">asphyxia-core.d.ts:383</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:406</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -226,21 +226,21 @@ $(data).attr(<span class="hljs-string">"tag.inner.0"</span>).__type <span class=
|
||||
</div>
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-xml"><span class="hljs-tag"><<span class="hljs-name">data</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s64"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>2<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"str"</span>></span>abc<span class="hljs-tag"></<span class="hljs-name">invalid</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s64"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>2<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"str"</span>></span>abc<span class="hljs-tag"></<span class="hljs-name">invalid</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">data</span>></span></code></pre>
|
||||
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
|
||||
<span class="hljs-attr">inner</span>: [
|
||||
K.ITEM(<span class="hljs-string">"s64"</span>, <span class="hljs-number">1n</span>),
|
||||
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>)
|
||||
K.ITEM(<span class="hljs-string">"s64"</span>, <span class="hljs-number">1n</span>),
|
||||
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>)
|
||||
],
|
||||
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">"str"</span>, <span class="hljs-string">"abc"</span>)
|
||||
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">"str"</span>, <span class="hljs-string">"abc"</span>)
|
||||
}</code></pre>
|
||||
<p>Evals:</p>
|
||||
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">"inner"</span>).bigint() <span class="hljs-comment">// 1n</span>
|
||||
$(data).bigint(<span class="hljs-string">"inner.1"</span>) <span class="hljs-comment">// 2n</span>
|
||||
$(data).bigint(<span class="hljs-string">"invalid"</span>, <span class="hljs-number">3n</span>) <span class="hljs-comment">// 3n</span></code></pre>
|
||||
<p>Eval:</p>
|
||||
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">"inner"</span>).bigint() <span class="hljs-comment">// 1n</span>
|
||||
$(data).bigint(<span class="hljs-string">"inner.1"</span>) <span class="hljs-comment">// 2n</span>
|
||||
$(data).bigint(<span class="hljs-string">"invalid"</span>, <span class="hljs-number">3n</span>) <span class="hljs-comment">// 3n</span></code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -269,26 +269,26 @@ $(data).bigint(<span class="hljs-string">"invalid"</span>, <span class="hljs-num
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L409">asphyxia-core.d.ts:409</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:432</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a bigint array from a tag. Only returns valid arrays
|
||||
when target tag has a type of <a href="../globals.html#kbiginttype">KBigIntType</a> or <a href="../globals.html#kbigintgrouptype">KBigIntGroupType</a></p>
|
||||
when target tag has a type of <a href="../index.html#kbiginttype">KBigIntType</a> or <a href="../index.html#kbigintgrouptype">KBigIntGroupType</a></p>
|
||||
</div>
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-xml"><span class="hljs-tag"><<span class="hljs-name">data</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s64"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"2"</span>></span>1 2<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"2"</span>></span>3 4<span class="hljs-tag"></<span class="hljs-name">invalid</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s64"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"2"</span>></span>1 2<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"2"</span>></span>3 4<span class="hljs-tag"></<span class="hljs-name">invalid</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">data</span>></span></code></pre>
|
||||
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
|
||||
<span class="hljs-attr">inner</span>: K.ARRAY(<span class="hljs-string">"s64"</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">"s32"</span>, [<span class="hljs-number">3</span>, <span class="hljs-number">4</span>])
|
||||
<span class="hljs-attr">inner</span>: K.ARRAY(<span class="hljs-string">"s64"</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">"s32"</span>, [<span class="hljs-number">3</span>, <span class="hljs-number">4</span>])
|
||||
}</code></pre>
|
||||
<p>Evals:</p>
|
||||
<pre><code class="language-javascript">$(data).bigints(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// [1n, 2n]</span>
|
||||
$(data).bigints(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// undefined</span></code></pre>
|
||||
<p>Eval:</p>
|
||||
<pre><code class="language-javascript">$(data).bigints(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// [1n, 2n]</span>
|
||||
$(data).bigints(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// undefined</span></code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -313,7 +313,7 @@ $(data).bigints(<span class="hljs-string">"invalid"</span>) <span class="hljs-co
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L437">asphyxia-core.d.ts:437</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:460</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -322,19 +322,19 @@ $(data).bigints(<span class="hljs-string">"invalid"</span>) <span class="hljs-co
|
||||
</div>
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-xml"><span class="hljs-tag"><<span class="hljs-name">data</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"bool"</span>></span>0<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>2<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"bool"</span>></span>0<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>2<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">data</span>></span></code></pre>
|
||||
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
|
||||
<span class="hljs-attr">inner</span>: [
|
||||
K.ITEM(<span class="hljs-string">"bool"</span>, <span class="hljs-literal">false</span>),
|
||||
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>)
|
||||
K.ITEM(<span class="hljs-string">"bool"</span>, <span class="hljs-literal">false</span>),
|
||||
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>)
|
||||
]
|
||||
}</code></pre>
|
||||
<p>Evals:</p>
|
||||
<pre><code class="language-javascript">$(data).bool(<span class="hljs-string">"inner.0"</span>) <span class="hljs-comment">// false</span>
|
||||
$(data).bool(<span class="hljs-string">"inner.1"</span>) <span class="hljs-comment">// true</span>
|
||||
$(data).bool(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// false</span></code></pre>
|
||||
<p>Eval:</p>
|
||||
<pre><code class="language-javascript">$(data).bool(<span class="hljs-string">"inner.0"</span>) <span class="hljs-comment">// false</span>
|
||||
$(data).bool(<span class="hljs-string">"inner.1"</span>) <span class="hljs-comment">// true</span>
|
||||
$(data).bool(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// false</span></code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -356,7 +356,7 @@ $(data).bool(<span class="hljs-string">"invalid"</span>) <span class="hljs-comme
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L463">asphyxia-core.d.ts:463</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:486</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -366,16 +366,16 @@ $(data).bool(<span class="hljs-string">"invalid"</span>) <span class="hljs-comme
|
||||
</div>
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-xml"><span class="hljs-tag"><<span class="hljs-name">data</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"bin"</span>></span>00ff<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"u8"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"3"</span>></span>1 2 3<span class="hljs-tag"></<span class="hljs-name">invalid</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"bin"</span>></span>00ff<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"u8"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"3"</span>></span>1 2 3<span class="hljs-tag"></<span class="hljs-name">invalid</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">data</span>></span></code></pre>
|
||||
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
|
||||
<span class="hljs-attr">inner</span>: K.ITEM(<span class="hljs-string">"bin"</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">"u8"</span>, [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>])
|
||||
<span class="hljs-attr">inner</span>: K.ITEM(<span class="hljs-string">"bin"</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">"u8"</span>, [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>])
|
||||
}</code></pre>
|
||||
<p>Evals:</p>
|
||||
<pre><code class="language-javascript">$(data).buffer(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// <Buffer 00 ff></span>
|
||||
$(data).buffer(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// undefined</span></code></pre>
|
||||
<p>Eval:</p>
|
||||
<pre><code class="language-javascript">$(data).buffer(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// <Buffer 00 ff></span>
|
||||
$(data).buffer(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// undefined</span></code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -400,7 +400,7 @@ $(data).buffer(<span class="hljs-string">"invalid"</span>) <span class="hljs-com
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L491">asphyxia-core.d.ts:491</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:514</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -409,19 +409,19 @@ $(data).buffer(<span class="hljs-string">"invalid"</span>) <span class="hljs-com
|
||||
</div>
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-xml"><span class="hljs-tag"><<span class="hljs-name">data</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">number</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">number</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">array</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"u8"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"3"</span>></span>1 2 3<span class="hljs-tag"></<span class="hljs-name">array</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">string</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"str"</span>></span>abc<span class="hljs-tag"></<span class="hljs-name">string</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">number</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">number</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">array</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"u8"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"3"</span>></span>1 2 3<span class="hljs-tag"></<span class="hljs-name">array</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">string</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"str"</span>></span>abc<span class="hljs-tag"></<span class="hljs-name">string</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">data</span>></span></code></pre>
|
||||
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
|
||||
<span class="hljs-attr">number</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>),
|
||||
<span class="hljs-attr">array</span>: K.ARRAY(<span class="hljs-string">"u8"</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">"str"</span>, <span class="hljs-string">"abc"</span>)
|
||||
<span class="hljs-attr">number</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>),
|
||||
<span class="hljs-attr">array</span>: K.ARRAY(<span class="hljs-string">"u8"</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">"str"</span>, <span class="hljs-string">"abc"</span>)
|
||||
}</code></pre>
|
||||
<p>Evals:</p>
|
||||
<pre><code class="language-javascript">$(data).content(<span class="hljs-string">"number"</span>) <span class="hljs-comment">// [1]</span>
|
||||
$(data).content(<span class="hljs-string">"array"</span>) <span class="hljs-comment">// [1, 2, 3]</span>
|
||||
$(data).content(<span class="hljs-string">"string"</span>) <span class="hljs-comment">// "abc"</span></code></pre>
|
||||
<p>Eval:</p>
|
||||
<pre><code class="language-javascript">$(data).content(<span class="hljs-string">"number"</span>) <span class="hljs-comment">// [1]</span>
|
||||
$(data).content(<span class="hljs-string">"array"</span>) <span class="hljs-comment">// [1, 2, 3]</span>
|
||||
$(data).content(<span class="hljs-string">"string"</span>) <span class="hljs-comment">// "abc"</span></code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -446,7 +446,7 @@ $(data).content(<span class="hljs-string">"string"</span>) <span class="hljs-com
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L523">asphyxia-core.d.ts:523</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:546</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -456,22 +456,22 @@ $(data).content(<span class="hljs-string">"string"</span>) <span class="hljs-com
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-xml"><span class="hljs-tag"><<span class="hljs-name">data</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">id</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">id</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">id</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">id</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">data</span>></span></code></pre>
|
||||
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
|
||||
<span class="hljs-attr">inner</span>: [
|
||||
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>) },
|
||||
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>) }
|
||||
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>) },
|
||||
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>) }
|
||||
]
|
||||
}</code></pre>
|
||||
<p>Evals:</p>
|
||||
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// <KDataReader></span>
|
||||
$(data).element(<span class="hljs-string">"inner"</span>).obj <span class="hljs-comment">// { id: [object] }</span>
|
||||
$(data).element(<span class="hljs-string">"inner"</span>).number(<span class="hljs-string">"id"</span>) <span class="hljs-comment">// 1</span></code></pre>
|
||||
<p>Eval:</p>
|
||||
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// <KDataReader></span>
|
||||
$(data).element(<span class="hljs-string">"inner"</span>).obj <span class="hljs-comment">// { id: [object] }</span>
|
||||
$(data).element(<span class="hljs-string">"inner"</span>).number(<span class="hljs-string">"id"</span>) <span class="hljs-comment">// 1</span></code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -493,7 +493,7 @@ $(data).element(<span class="hljs-string">"inner"</span>).number(<span class="hl
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L554">asphyxia-core.d.ts:554</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:577</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -503,21 +503,21 @@ $(data).element(<span class="hljs-string">"inner"</span>).number(<span class="hl
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-xml"><span class="hljs-tag"><<span class="hljs-name">data</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">id</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">id</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">id</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">id</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">data</span>></span></code></pre>
|
||||
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
|
||||
<span class="hljs-attr">inner</span>: [
|
||||
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>) },
|
||||
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>) }
|
||||
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>) },
|
||||
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>) }
|
||||
]
|
||||
}</code></pre>
|
||||
<p>Evals:</p>
|
||||
<pre><code class="language-javascript">$(data).elements(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// [<KDataReader>, <KDataReader>]</span>
|
||||
$(data).elements(<span class="hljs-string">"inner"</span>)[<span class="hljs-number">1</span>].number(<span class="hljs-string">"id"</span>) <span class="hljs-comment">// 2</span></code></pre>
|
||||
<p>Eval:</p>
|
||||
<pre><code class="language-javascript">$(data).elements(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// [<KDataReader>, <KDataReader>]</span>
|
||||
$(data).elements(<span class="hljs-string">"inner"</span>)[<span class="hljs-number">1</span>].number(<span class="hljs-string">"id"</span>) <span class="hljs-comment">// 2</span></code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -539,7 +539,7 @@ $(data).elements(<span class="hljs-string">"inner"</span>)[<span class="hljs-num
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L587">asphyxia-core.d.ts:587</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:610</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -548,21 +548,21 @@ $(data).elements(<span class="hljs-string">"inner"</span>)[<span class="hljs-num
|
||||
</div>
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-xml"><span class="hljs-tag"><<span class="hljs-name">data</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s64"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>2<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"str"</span>></span>abc<span class="hljs-tag"></<span class="hljs-name">invalid</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s64"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>2<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"str"</span>></span>abc<span class="hljs-tag"></<span class="hljs-name">invalid</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">data</span>></span></code></pre>
|
||||
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
|
||||
<span class="hljs-attr">inner</span>: [
|
||||
K.ITEM(<span class="hljs-string">"s64"</span>, <span class="hljs-number">1n</span>),
|
||||
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>)
|
||||
K.ITEM(<span class="hljs-string">"s64"</span>, <span class="hljs-number">1n</span>),
|
||||
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>)
|
||||
],
|
||||
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">"str"</span>, <span class="hljs-string">"abc"</span>)
|
||||
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">"str"</span>, <span class="hljs-string">"abc"</span>)
|
||||
}</code></pre>
|
||||
<p>Evals:</p>
|
||||
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">"inner"</span>).number() <span class="hljs-comment">// 1</span>
|
||||
$(data).number(<span class="hljs-string">"inner.1"</span>) <span class="hljs-comment">// 2</span>
|
||||
$(data).number(<span class="hljs-string">"invalid"</span>, <span class="hljs-number">3</span>) <span class="hljs-comment">// 3</span></code></pre>
|
||||
<p>Eval:</p>
|
||||
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">"inner"</span>).number() <span class="hljs-comment">// 1</span>
|
||||
$(data).number(<span class="hljs-string">"inner.1"</span>) <span class="hljs-comment">// 2</span>
|
||||
$(data).number(<span class="hljs-string">"invalid"</span>, <span class="hljs-number">3</span>) <span class="hljs-comment">// 3</span></code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -591,26 +591,26 @@ $(data).number(<span class="hljs-string">"invalid"</span>, <span class="hljs-num
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L613">asphyxia-core.d.ts:613</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:636</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a number array from a tag. Only returns valid arrays
|
||||
when target tag has a type of <a href="../globals.html#knumbertype">KNumberType</a> or <a href="../globals.html#knumbergrouptype">KNumberGroupType</a></p>
|
||||
when target tag has a type of <a href="../index.html#knumbertype">KNumberType</a> or <a href="../index.html#knumbergrouptype">KNumberGroupType</a></p>
|
||||
</div>
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-xml"><span class="hljs-tag"><<span class="hljs-name">data</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s64"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"2"</span>></span>1 2<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"2"</span>></span>3 4<span class="hljs-tag"></<span class="hljs-name">invalid</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s64"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"2"</span>></span>1 2<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"2"</span>></span>3 4<span class="hljs-tag"></<span class="hljs-name">invalid</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">data</span>></span></code></pre>
|
||||
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
|
||||
<span class="hljs-attr">invalid</span>: K.ARRAY(<span class="hljs-string">"s64"</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">"s32"</span>, [<span class="hljs-number">3</span>, <span class="hljs-number">4</span>])
|
||||
<span class="hljs-attr">invalid</span>: K.ARRAY(<span class="hljs-string">"s64"</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">"s32"</span>, [<span class="hljs-number">3</span>, <span class="hljs-number">4</span>])
|
||||
}</code></pre>
|
||||
<p>Evals:</p>
|
||||
<pre><code class="language-javascript">$(data).bigints(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// undefined</span>
|
||||
$(data).bigints(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// [3, 4]</span></code></pre>
|
||||
<p>Eval:</p>
|
||||
<pre><code class="language-javascript">$(data).bigints(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// undefined</span>
|
||||
$(data).bigints(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// [3, 4]</span></code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -635,7 +635,7 @@ $(data).bigints(<span class="hljs-string">"inner"</span>) <span class="hljs-comm
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L639">asphyxia-core.d.ts:639</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:662</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -645,16 +645,16 @@ $(data).bigints(<span class="hljs-string">"inner"</span>) <span class="hljs-comm
|
||||
</div>
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-xml"><span class="hljs-tag"><<span class="hljs-name">data</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"str"</span>></span>abc<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">invalid</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"str"</span>></span>abc<span class="hljs-tag"></<span class="hljs-name">inner</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>></span>1<span class="hljs-tag"></<span class="hljs-name">invalid</span>></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">data</span>></span></code></pre>
|
||||
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
|
||||
<span class="hljs-attr">inner</span>: K.ITEM(<span class="hljs-string">"str"</span>, <span class="hljs-string">"abc"</span>),
|
||||
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>)
|
||||
<span class="hljs-attr">inner</span>: K.ITEM(<span class="hljs-string">"str"</span>, <span class="hljs-string">"abc"</span>),
|
||||
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>)
|
||||
}</code></pre>
|
||||
<p>Evals:</p>
|
||||
<pre><code class="language-javascript">$(data).str(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// "abc"</span>
|
||||
$(data).str(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// undefined</span></code></pre>
|
||||
<p>Eval:</p>
|
||||
<pre><code class="language-javascript">$(data).str(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// "abc"</span>
|
||||
$(data).str(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// undefined</span></code></pre>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -675,7 +675,7 @@ $(data).str(<span class="hljs-string">"invalid"</span>) <span class="hljs-commen
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -741,29 +741,41 @@ $(data).str(<span class="hljs-string">"invalid"</span>) <span class="hljs-commen
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
<a href="../index.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
<a href="../index.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
<a href="../index.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
<a href="../index.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
<a href="../index.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
<a href="../index.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
<a href="../index.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version" class="tsd-kind-icon">CORE_<wbr>VERSION</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version_major" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MAJOR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version_minor" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MINOR</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -790,6 +802,5 @@ $(data).str(<span class="hljs-string">"invalid"</span>) <span class="hljs-commen
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,344 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Asphyxia CORE Module API</title>
|
||||
<meta name="description" content="Documentation for Asphyxia CORE Module API">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="index.html" class="title">Asphyxia CORE Module API</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="globals.html">Globals</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Asphyxia CORE Module API</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Namespaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-namespace"><a href="modules/_.html" class="tsd-kind-icon">$</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/db.html" class="tsd-kind-icon">DB</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/io.html" class="tsd-kind-icon">IO</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/k.html" class="tsd-kind-icon">K</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/r.html" class="tsd-kind-icon">R</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/u.html" class="tsd-kind-icon">U</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-class"><a href="classes/kdatareader.html" class="tsd-kind-icon">KData<wbr>Reader</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface"><a href="interfaces/configoption.html" class="tsd-kind-icon">Config<wbr>Option</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/eamuseinfo.html" class="tsd-kind-icon">Eamuse<wbr>Info</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/eamusesend.html" class="tsd-kind-icon">Eamuse<wbr>Send</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias"><a href="globals.html#epr" class="tsd-kind-icon">EPR</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="globals.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="globals.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="globals.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="globals.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="globals.html#kencoding" class="tsd-kind-icon">KEncoding</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="globals.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="globals.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="epr" class="tsd-anchor"></a>
|
||||
<h3>EPR</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">EPR<span class="tsd-signature-symbol">:</span> <a href="globals.html#eamusepluginroute" class="tsd-signature-type">EamusePluginRoute</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L234">asphyxia-core.d.ts:234</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Helper type for typing your custom route.</p>
|
||||
</div>
|
||||
<p>Alias for <a href="globals.html#eamusepluginroute">EamusePluginRoute</a></p>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="eamusepluginroute" class="tsd-anchor"></a>
|
||||
<h3>Eamuse<wbr>Plugin<wbr>Route</h3>
|
||||
<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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L223">asphyxia-core.d.ts:223</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Helper type for typing your custom route.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
|
||||
<li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>req: <a href="interfaces/eamuseinfo.html" class="tsd-signature-type">EamuseInfo</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>send: <a href="interfaces/eamusesend.html" class="tsd-signature-type">EamuseSend</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="kattrmap" class="tsd-anchor"></a>
|
||||
<h3>KAttr<wbr>Map</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">KAttr<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L60">asphyxia-core.d.ts:60</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Attribute object</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-index-signature">
|
||||
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="kbigintgrouptype" class="tsd-anchor"></a>
|
||||
<h3>KBig<wbr>Int<wbr>Group<wbr>Type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2s64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2u64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3s64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3u64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4s64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4u64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vs8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vu8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vs16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vu16"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L45">asphyxia-core.d.ts:45</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="kbiginttype" class="tsd-anchor"></a>
|
||||
<h3>KBig<wbr>Int<wbr>Type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">KBig<wbr>Int<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"s64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"u64"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L15">asphyxia-core.d.ts:15</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="kencoding" class="tsd-anchor"></a>
|
||||
<h3>KEncoding</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">KEncoding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"shift_jis"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"utf8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"euc-jp"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ascii"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"iso-8859-1"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L65">asphyxia-core.d.ts:65</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Supported response encoding</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="knumbergrouptype" class="tsd-anchor"></a>
|
||||
<h3>KNumber<wbr>Group<wbr>Type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">KNumber<wbr>Group<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2s8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2s16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2u16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2s32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2u32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2f"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2d"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3s8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3s16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3u16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3s32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3u32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3f"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3d"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4s8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4s16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4u16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4s32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4u32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4f"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4d"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2b"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3b"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4b"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vb"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L16">asphyxia-core.d.ts:16</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="knumbertype" class="tsd-anchor"></a>
|
||||
<h3>KNumber<wbr>Type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">KNumber<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"s8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"s16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"u16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"s32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"u32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"time"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ip4"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"float"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"double"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"bool"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L3">asphyxia-core.d.ts:3</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals current ">
|
||||
<a href="globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/_.html">$</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/db.html">DB</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/io.html">IO</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/k.html">K</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/r.html">R</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/u.html">U</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/kdatareader.html" class="tsd-kind-icon">KData<wbr>Reader</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/configoption.html" class="tsd-kind-icon">Config<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/eamuseinfo.html" class="tsd-kind-icon">Eamuse<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/eamusesend.html" class="tsd-kind-icon">Eamuse<wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
+266
-19
@@ -51,7 +51,7 @@
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="globals.html">Globals</a>
|
||||
<a href="index.html">Globals</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Asphyxia CORE Module API</h1>
|
||||
@@ -61,18 +61,254 @@
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<div class="tsd-panel tsd-typography">
|
||||
<a href="#asphyxia-core" id="asphyxia-core" style="color: inherit; text-decoration: none;">
|
||||
<h4>Asphyxia CORE</h4>
|
||||
</a>
|
||||
<p>Quick Start guide coming soon.</p>
|
||||
</div>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Namespaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-namespace"><a href="modules/_.html" class="tsd-kind-icon">$</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/db.html" class="tsd-kind-icon">DB</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/io.html" class="tsd-kind-icon">IO</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/k.html" class="tsd-kind-icon">K</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/r.html" class="tsd-kind-icon">R</a></li>
|
||||
<li class="tsd-kind-namespace"><a href="modules/u.html" class="tsd-kind-icon">U</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-class"><a href="classes/kdatareader.html" class="tsd-kind-icon">KData<wbr>Reader</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface"><a href="interfaces/configoption.html" class="tsd-kind-icon">Config<wbr>Option</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/eamuseinfo.html" class="tsd-kind-icon">Eamuse<wbr>Info</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/eamusesend.html" class="tsd-kind-icon">Eamuse<wbr>Send</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/fileoption.html" class="tsd-kind-icon">File<wbr>Option</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias"><a href="index.html#epr" class="tsd-kind-icon">EPR</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="index.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="index.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="index.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="index.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="index.html#kencoding" class="tsd-kind-icon">KEncoding</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="index.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a></li>
|
||||
<li class="tsd-kind-type-alias"><a href="index.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable"><a href="index.html#core_version" class="tsd-kind-icon">CORE_<wbr>VERSION</a></li>
|
||||
<li class="tsd-kind-variable"><a href="index.html#core_version_major" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MAJOR</a></li>
|
||||
<li class="tsd-kind-variable"><a href="index.html#core_version_minor" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MINOR</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="epr" class="tsd-anchor"></a>
|
||||
<h3>EPR</h3>
|
||||
<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:251</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Helper type for typing your custom route.</p>
|
||||
</div>
|
||||
<p>Alias for <a href="index.html#eamusepluginroute">EamusePluginRoute</a></p>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="eamusepluginroute" class="tsd-anchor"></a>
|
||||
<h3>Eamuse<wbr>Plugin<wbr>Route</h3>
|
||||
<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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in asphyxia-core.d.ts:244</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Helper type for typing your custom route.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
|
||||
<li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>req: <a href="interfaces/eamuseinfo.html" class="tsd-signature-type">EamuseInfo</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>send: <a href="interfaces/eamusesend.html" class="tsd-signature-type">EamuseSend</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="kattrmap" class="tsd-anchor"></a>
|
||||
<h3>KAttr<wbr>Map</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">KAttr<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in asphyxia-core.d.ts:76</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Attribute object</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-index-signature">
|
||||
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="kbigintgrouptype" class="tsd-anchor"></a>
|
||||
<h3>KBig<wbr>Int<wbr>Group<wbr>Type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2s64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2u64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3s64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3u64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4s64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4u64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vs8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vu8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vs16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vu16"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in asphyxia-core.d.ts:61</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="kbiginttype" class="tsd-anchor"></a>
|
||||
<h3>KBig<wbr>Int<wbr>Type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">KBig<wbr>Int<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"s64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"u64"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in asphyxia-core.d.ts:31</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="kencoding" class="tsd-anchor"></a>
|
||||
<h3>KEncoding</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">KEncoding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"shift_jis"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"utf8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"euc-jp"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ascii"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"iso-8859-1"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in asphyxia-core.d.ts:81</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Supported response encoding</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="knumbergrouptype" class="tsd-anchor"></a>
|
||||
<h3>KNumber<wbr>Group<wbr>Type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">KNumber<wbr>Group<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2s8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2s16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2u16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2s32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2u32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2f"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2d"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3s8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3s16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3u16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3s32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3u32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3f"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3d"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4s8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4s16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4u16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4s32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4u32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4f"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4d"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2b"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3b"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4b"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vb"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in asphyxia-core.d.ts:32</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||
<a name="knumbertype" class="tsd-anchor"></a>
|
||||
<h3>KNumber<wbr>Type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">KNumber<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"s8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"s16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"u16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"s32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"u32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"time"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ip4"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"float"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"double"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"bool"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in asphyxia-core.d.ts:19</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="core_version" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> CORE_<wbr>VERSION</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">CORE_<wbr>VERSION<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:7</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Version string of Asphyxia CORE, for example "v1.19"</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="core_version_major" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> CORE_<wbr>VERSION_<wbr>MAJOR</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MAJOR<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:12</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Major version of Asphyxia CORE, for version <code>v1.19</code>, this number is 1.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable">
|
||||
<a name="core_version_minor" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> CORE_<wbr>VERSION_<wbr>MINOR</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MINOR<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:17</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Minor version of Asphyxia CORE, for version <code>v1.19</code>, this number is 19.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="globals.html"><em>Globals</em></a>
|
||||
<li class="globals current ">
|
||||
<a href="index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="modules/_.html">$</a>
|
||||
@@ -111,29 +347,41 @@
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
<a href="index.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
<a href="index.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
<a href="index.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
<a href="index.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
<a href="index.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
<a href="index.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="globals.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
<a href="index.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="index.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="index.html#core_version" class="tsd-kind-icon">CORE_<wbr>VERSION</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="index.html#core_version_major" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MAJOR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="index.html#core_version_minor" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MINOR</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -160,6 +408,5 @@
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -51,7 +51,7 @@
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="configoption.html">ConfigOption</a>
|
||||
@@ -67,7 +67,7 @@
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Detail of a config</p>
|
||||
<p>Details of a config</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
@@ -107,7 +107,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L100">asphyxia-core.d.ts:100</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:111</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -122,7 +122,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">desc<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L88">asphyxia-core.d.ts:88</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:99</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -137,12 +137,12 @@
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L86">asphyxia-core.d.ts:86</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:97</li>
|
||||
</ul>
|
||||
</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>
|
||||
@@ -152,7 +152,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">need<wbr>Restart<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L98">asphyxia-core.d.ts:98</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:109</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -167,7 +167,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L96">asphyxia-core.d.ts:96</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:107</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -182,7 +182,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">range<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L92">asphyxia-core.d.ts:92</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:103</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -197,7 +197,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"string"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"integer"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"float"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"boolean"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L90">asphyxia-core.d.ts:90</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:101</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -212,7 +212,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">validator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>data<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">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L94">asphyxia-core.d.ts:94</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:105</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -248,7 +248,7 @@
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -299,29 +299,41 @@
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
<a href="../index.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
<a href="../index.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
<a href="../index.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
<a href="../index.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
<a href="../index.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
<a href="../index.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
<a href="../index.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version" class="tsd-kind-icon">CORE_<wbr>VERSION</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version_major" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MAJOR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version_minor" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MINOR</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -348,6 +360,5 @@
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -51,7 +51,7 @@
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="eamuseinfo.html">EamuseInfo</a>
|
||||
@@ -102,7 +102,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L77">asphyxia-core.d.ts:77</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:88</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -112,7 +112,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">model<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L78">asphyxia-core.d.ts:78</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:89</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -122,7 +122,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L76">asphyxia-core.d.ts:76</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:87</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -132,7 +132,7 @@
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -168,29 +168,41 @@
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
<a href="../index.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
<a href="../index.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
<a href="../index.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
<a href="../index.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
<a href="../index.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
<a href="../index.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
<a href="../index.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version" class="tsd-kind-icon">CORE_<wbr>VERSION</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version_major" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MAJOR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version_minor" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MINOR</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -217,6 +229,5 @@
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -51,7 +51,7 @@
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="eamusesend.html">EamuseSend</a>
|
||||
@@ -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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L136">asphyxia-core.d.ts:136</a></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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L169">asphyxia-core.d.ts:169</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:198</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -144,18 +144,18 @@
|
||||
<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">"1"</span> }, {
|
||||
inner: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>)
|
||||
<span class="hljs-attribute">outer</span>: K.<span class="hljs-built_in">ATTR</span>({ status: <span class="hljs-string">"1"</span> }, {
|
||||
inner: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>)
|
||||
})
|
||||
}</code></pre>
|
||||
</div>
|
||||
<p>Or follow xml-like format manually:</p>
|
||||
<pre><code>{
|
||||
outter: {
|
||||
<span class="hljs-string">"@attr"</span>: { status: <span class="hljs-string">"1"</span> },
|
||||
outer: {
|
||||
<span class="hljs-string">"@attr"</span>: { status: <span class="hljs-string">"1"</span> },
|
||||
inner: {
|
||||
<span class="hljs-string">"@attr"</span>: { __type: <span class="hljs-string">"s32"</span> },
|
||||
<span class="hljs-string">"@content"</span>: [<span class="hljs-number">1</span>]
|
||||
<span class="hljs-string">"@attr"</span>: { __type: <span class="hljs-string">"s32"</span> },
|
||||
<span class="hljs-string">"@content"</span>: [<span class="hljs-number">1</span>]
|
||||
}
|
||||
}
|
||||
}</code></pre>
|
||||
@@ -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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L189">asphyxia-core.d.ts:189</a></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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L213">asphyxia-core.d.ts:213</a></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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L141">asphyxia-core.d.ts:141</a></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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L131">asphyxia-core.d.ts:131</a></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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L179">asphyxia-core.d.ts:179</a></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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L199">asphyxia-core.d.ts:199</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:228</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -490,7 +490,7 @@
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -541,29 +541,41 @@
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
<a href="../index.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
<a href="../index.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
<a href="../index.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
<a href="../index.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
<a href="../index.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
<a href="../index.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
<a href="../index.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version" class="tsd-kind-icon">CORE_<wbr>VERSION</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version_major" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MAJOR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version_minor" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MINOR</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -590,6 +602,5 @@
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -51,7 +51,7 @@
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="eamusesendoption.html">EamuseSendOption</a>
|
||||
@@ -105,17 +105,17 @@
|
||||
<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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L122">asphyxia-core.d.ts:122</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:151</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="encoding" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> encoding</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">encoding<span class="tsd-signature-symbol">:</span> <a href="../globals.html#kencoding" class="tsd-signature-type">KEncoding</a></div>
|
||||
<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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L113">asphyxia-core.d.ts:113</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L124">asphyxia-core.d.ts:124</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L123">asphyxia-core.d.ts:123</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L120">asphyxia-core.d.ts:120</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L107">asphyxia-core.d.ts:107</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:136</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -178,7 +178,7 @@
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -223,29 +223,41 @@
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
<a href="../index.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
<a href="../index.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
<a href="../index.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
<a href="../index.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
<a href="../index.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
<a href="../index.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
<a href="../index.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version" class="tsd-kind-icon">CORE_<wbr>VERSION</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version_major" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MAJOR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version_minor" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MINOR</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -272,6 +284,5 @@
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,268 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>FileOption | Asphyxia CORE Module API</title>
|
||||
<meta name="description" content="Documentation for Asphyxia CORE Module API">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="fileoption.html">FileOption</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface FileOption</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Details of a data file</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">FileOption</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="fileoption.html#accept" class="tsd-kind-icon">accept</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="fileoption.html#desc" class="tsd-kind-icon">desc</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="fileoption.html#name" class="tsd-kind-icon">name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="fileoption.html#required" class="tsd-kind-icon">required</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="accept" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> accept</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">accept<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:123</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The accept attribute of the file input element. See <a href="https://www.w3schools.com/tags/att_input_accept.asp" class="external">https://www.w3schools.com/tags/att_input_accept.asp</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="desc" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> desc</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">desc<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:121</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Provide a description for the entry</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">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:119</li>
|
||||
</ul>
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="required" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> required</h3>
|
||||
<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:129</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<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>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/kdatareader.html" class="tsd-kind-icon">KData<wbr>Reader</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="configoption.html" class="tsd-kind-icon">Config<wbr>Option</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="eamuseinfo.html" class="tsd-kind-icon">Eamuse<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="eamusesend.html" class="tsd-kind-icon">Eamuse<wbr>Send</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface">
|
||||
<a href="fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="fileoption.html#accept" class="tsd-kind-icon">accept</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="fileoption.html#desc" class="tsd-kind-icon">desc</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="fileoption.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="fileoption.html#required" class="tsd-kind-icon">required</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#epr" class="tsd-kind-icon">EPR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#kencoding" class="tsd-kind-icon">KEncoding</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../index.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version" class="tsd-kind-icon">CORE_<wbr>VERSION</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version_major" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MAJOR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable">
|
||||
<a href="../index.html#core_version_minor" class="tsd-kind-icon">CORE_<wbr>VERSION_<wbr>MINOR</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
+16
-17
@@ -51,7 +51,7 @@
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_.html">$</a>
|
||||
@@ -73,7 +73,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L645">asphyxia-core.d.ts:645</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:668</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -120,13 +120,13 @@
|
||||
<a name="attr" class="tsd-anchor"></a>
|
||||
<h3>ATTR</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">ATTR<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ATTR<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L647">asphyxia-core.d.ts:647</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:670</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -138,7 +138,7 @@
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h4>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -152,7 +152,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L648">asphyxia-core.d.ts:648</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L649">asphyxia-core.d.ts:649</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L650">asphyxia-core.d.ts:650</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L651">asphyxia-core.d.ts:651</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L652">asphyxia-core.d.ts:652</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L653">asphyxia-core.d.ts:653</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L654">asphyxia-core.d.ts:654</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L655">asphyxia-core.d.ts:655</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L656">asphyxia-core.d.ts:656</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L657">asphyxia-core.d.ts:657</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:680</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -435,7 +435,7 @@
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
<li class="current tsd-kind-namespace">
|
||||
<a href="_.html">$</a>
|
||||
@@ -517,6 +517,5 @@
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
+30
-29
@@ -51,7 +51,7 @@
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="db.html">DB</a>
|
||||
@@ -76,9 +76,11 @@
|
||||
<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.
|
||||
However, <code>__refid</code> field will still be ignored while other <code>__</code> starting fields will cause an error to be thrown.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
@@ -113,7 +115,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L1029">asphyxia-core.d.ts:1029</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1105</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -136,7 +138,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L1030">asphyxia-core.d.ts:1030</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1106</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -159,14 +161,14 @@
|
||||
<a name="find" class="tsd-anchor"></a>
|
||||
<h3>Find</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">Find<T><span class="tsd-signature-symbol">(</span>refid<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>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">Find<T><span class="tsd-signature-symbol">(</span>refid<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>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">ProfileDoc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">Find<T><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L986">asphyxia-core.d.ts:986</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1062</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -184,12 +186,12 @@
|
||||
<h5>query: <span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProfileDoc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L987">asphyxia-core.d.ts:987</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1063</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -212,14 +214,14 @@
|
||||
<a name="findone" class="tsd-anchor"></a>
|
||||
<h3>Find<wbr>One</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">Find<wbr>One<T><span class="tsd-signature-symbol">(</span>refid<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>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">Find<wbr>One<T><span class="tsd-signature-symbol">(</span>refid<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>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">ProfileDoc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">Find<wbr>One<T><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L983">asphyxia-core.d.ts:983</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1059</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -237,12 +239,12 @@
|
||||
<h5>query: <span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProfileDoc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L984">asphyxia-core.d.ts:984</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1060</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -265,14 +267,14 @@
|
||||
<a name="insert" class="tsd-anchor"></a>
|
||||
<h3>Insert</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">Insert<T><span class="tsd-signature-symbol">(</span>refid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, doc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</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"><</span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">Insert<T><span class="tsd-signature-symbol">(</span>refid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, doc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</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"><</span><span class="tsd-signature-type">ProfileDoc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">Insert<T><span class="tsd-signature-symbol">(</span>doc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</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"><</span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L989">asphyxia-core.d.ts:989</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1065</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -290,12 +292,12 @@
|
||||
<h5>doc: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProfileDoc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L990">asphyxia-core.d.ts:990</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1066</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -325,7 +327,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L992">asphyxia-core.d.ts:992</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1068</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -348,7 +350,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L993">asphyxia-core.d.ts:993</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1069</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -371,14 +373,14 @@
|
||||
<a name="update" class="tsd-anchor"></a>
|
||||
<h3>Update</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">Update<T><span class="tsd-signature-symbol">(</span>refid<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>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span>, update<span class="tsd-signature-symbol">: </span><a href="" class="tsd-signature-type">Update</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">Update<T><span class="tsd-signature-symbol">(</span>refid<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>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span>, update<span class="tsd-signature-symbol">: </span><a href="" class="tsd-signature-type">Update</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProfileDoc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">Update<T><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span>, update<span class="tsd-signature-symbol">: </span><a href="" class="tsd-signature-type">Update</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L995">asphyxia-core.d.ts:995</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1071</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -399,12 +401,12 @@
|
||||
<h5>update: <a href="" class="tsd-signature-type">Update</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProfileDoc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L1003">asphyxia-core.d.ts:1003</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1079</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -430,14 +432,14 @@
|
||||
<a name="upsert" class="tsd-anchor"></a>
|
||||
<h3>Upsert</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">Upsert<T><span class="tsd-signature-symbol">(</span>refid<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>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span>, update<span class="tsd-signature-symbol">: </span><a href="db.html#update" class="tsd-signature-type">Update</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>upsert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">Upsert<T><span class="tsd-signature-symbol">(</span>refid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span>, update<span class="tsd-signature-symbol">: </span><a href="db.html#update" class="tsd-signature-type">Update</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProfileDoc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>upsert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">Upsert<T><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span>, update<span class="tsd-signature-symbol">: </span><a href="db.html#update" class="tsd-signature-type">Update</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>upsert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L1011">asphyxia-core.d.ts:1011</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1087</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -449,7 +451,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>refid: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
||||
<h5>refid: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>query: <span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
|
||||
@@ -458,12 +460,12 @@
|
||||
<h5>update: <a href="db.html#update" class="tsd-signature-type">Update</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>upsert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProfileDoc</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>upsert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L1020">asphyxia-core.d.ts:1020</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:1096</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
@@ -491,7 +493,7 @@
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="_.html">$</a>
|
||||
@@ -561,6 +563,5 @@
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
+58
-20
@@ -51,7 +51,7 @@
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="io.html">IO</a>
|
||||
@@ -69,7 +69,7 @@
|
||||
<div class="lead">
|
||||
<p>Filesystem IO</p>
|
||||
</div>
|
||||
<p>These are designed to match nodejs <code>fs</code> module. Along with custom filesystem implementation for reading compressed data.</p>
|
||||
<p>These are designed to match nodejs <code>fs</code> module.</p>
|
||||
<p><strong>DO NOT</strong> use IO for savedata. Please use <a href="db.html">DB</a> namespace so your data can be managed by WebUI.</p>
|
||||
<p>Also, due to difference between operating systems, you should always prepare your files using ascii path.
|
||||
Both UTF-8 and local encodings will have cross-platform compatibility issues.</p>
|
||||
@@ -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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L759">asphyxia-core.d.ts:759</a></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"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></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"><</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></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"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></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"><</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">></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"><</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></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"><</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">></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"><</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">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L798">asphyxia-core.d.ts:798</a></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>'r'</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"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</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">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L810">asphyxia-core.d.ts:810</a></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>'r'</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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</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><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L822">asphyxia-core.d.ts:822</a></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>'r'</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"><</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></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</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">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L836">asphyxia-core.d.ts:836</a></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"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</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">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -259,7 +295,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L753">asphyxia-core.d.ts:753</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L774">asphyxia-core.d.ts:774</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L789">asphyxia-core.d.ts:789</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:851</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -361,7 +397,7 @@
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="_.html">$</a>
|
||||
@@ -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>
|
||||
@@ -422,6 +461,5 @@
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
+127
-77
@@ -51,7 +51,7 @@
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="k.html">K</a>
|
||||
@@ -79,9 +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="k.html#array" class="tsd-kind-icon">ARRAY</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="k.html#attr" class="tsd-kind-icon">ATTR</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="k.html#item" class="tsd-kind-icon">ITEM</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="k.html#array" class="tsd-kind-icon">ARRAY</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="k.html#attr" class="tsd-kind-icon">ATTR</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="k.html#item" class="tsd-kind-icon">ITEM</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
@@ -89,34 +89,40 @@
|
||||
</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">
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<a name="array" class="tsd-anchor"></a>
|
||||
<h3>ARRAY</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">ARRAY<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"s8"</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ARRAY<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../globals.html#knumbertype" class="tsd-signature-type">KNumberType</a>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ARRAY<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../globals.html#kbiginttype" class="tsd-signature-type">KBigIntType</a>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">ARRAY<S><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KARRAY</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ARRAY<S><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KARRAY</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ARRAY<S><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KARRAY</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L734">asphyxia-core.d.ts:734</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:793</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Example:</p>
|
||||
<pre><code>{
|
||||
<span class="hljs-attribute">tag</span>: K.<span class="hljs-built_in">ARRAY</span>(<span class="hljs-string">'s32'</span>, [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>], {attr: <span class="hljs-string">"4"</span>})
|
||||
<span class="hljs-attribute">tag</span>: K.<span class="hljs-built_in">ARRAY</span>(<span class="hljs-string">'s32'</span>, [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>], {attr: <span class="hljs-string">"4"</span>})
|
||||
}</code></pre><p>Represents:</p>
|
||||
<pre><code><tag __type=<span class="hljs-string">"s32"</span> __count=<span class="hljs-string">"3"</span> attr=<span class="hljs-string">"2"</span>><span class="hljs-number">1</span> <span class="hljs-number">2</span> <span class="hljs-number">3</span></tag></code></pre>
|
||||
<pre><code><span class="hljs-tag"><<span class="hljs-name">tag</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"3"</span> <span class="hljs-attr">attr</span>=<span class="hljs-string">"2"</span>></span>1 2 3<span class="hljs-tag"></<span class="hljs-name">tag</span>></span></code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>S<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"s8"</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>type: <span class="tsd-signature-type">"u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"s8"</span></h5>
|
||||
<h5>type: <span class="tsd-signature-type">S</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p><strong>__type</strong> attribute, which is used during encoding and compression</p>
|
||||
</div>
|
||||
@@ -128,129 +134,150 @@
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>attribute map in addition to <strong>__type</strong> and <strong>__count</strong></p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">KARRAY</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L735">asphyxia-core.d.ts:735</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:794</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>S<span class="tsd-signature-symbol">: </span><a href="../index.html#knumbertype" class="tsd-signature-type">KNumberType</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>type: <a href="../globals.html#knumbertype" class="tsd-signature-type">KNumberType</a></h5>
|
||||
<h5>type: <span class="tsd-signature-type">S</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>content: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">KARRAY</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L736">asphyxia-core.d.ts:736</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:795</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>S<span class="tsd-signature-symbol">: </span><a href="../index.html#kbiginttype" class="tsd-signature-type">KBigIntType</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>type: <a href="../globals.html#kbiginttype" class="tsd-signature-type">KBigIntType</a></h5>
|
||||
<h5>type: <span class="tsd-signature-type">S</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>content: <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">KARRAY</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<a name="attr" class="tsd-anchor"></a>
|
||||
<h3>ATTR</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">ATTR<span class="tsd-signature-symbol">(</span>attr<span class="tsd-signature-symbol">: </span><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a>, inner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">ATTR<M, T><span class="tsd-signature-symbol">(</span>attr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">M</span>, inner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KATTR</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">M</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L685">asphyxia-core.d.ts:685</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:752</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Example:</p>
|
||||
<pre><code>{
|
||||
tag: K.ATTR({attr: <span class="hljs-string">"1"</span>}, {
|
||||
tag: K.ATTR({attr: <span class="hljs-string">"1"</span>}, {
|
||||
inner: [{}, {}]
|
||||
})
|
||||
}</code></pre><p>Represents:</p>
|
||||
<pre><code><span class="hljs-tag"><<span class="hljs-name">tag</span> <span class="hljs-attr">attr</span>=<span class="hljs-string">"1"</span>></span>
|
||||
<pre><code><span class="hljs-tag"><<span class="hljs-name">tag</span> <span class="hljs-attr">attr</span>=<span class="hljs-string">"1"</span>></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span>/></span>
|
||||
<span class="hljs-tag"><<span class="hljs-name">inner</span>/></span>
|
||||
<span class="hljs-tag"></<span class="hljs-name">tag</span>></span></code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>M<span class="tsd-signature-symbol">: </span><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h4>
|
||||
</li>
|
||||
<li>
|
||||
<h4>T</h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<h5>attr: <span class="tsd-signature-type">M</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Attribute map</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> inner: <span class="tsd-signature-type">any</span></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> inner: <span class="tsd-signature-type">T</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Inner tag/data</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">KATTR</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">M</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<a name="item" class="tsd-anchor"></a>
|
||||
<h3>ITEM</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"str"</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"bin"</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ip4"</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"bool"</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../globals.html#knumbertype" class="tsd-signature-type">KNumberType</a>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../globals.html#kbiginttype" class="tsd-signature-type">KBigIntType</a>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bigint</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../globals.html#knumbergrouptype" class="tsd-signature-type">KNumberGroupType</a>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../globals.html#kbigintgrouptype" class="tsd-signature-type">KBigIntGroupType</a>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"str"</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"str"</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"bin"</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"bin"</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ip4"</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"ip4"</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"bool"</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"bool"</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<S><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<S><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bigint</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<S><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ITEM<S><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span>, attr<span class="tsd-signature-symbol">?: </span><a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L702">asphyxia-core.d.ts:702</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:769</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Example:</p>
|
||||
<pre><code>{
|
||||
<span class="hljs-attribute">tag</span>: K.<span class="hljs-built_in">ITEM</span>(<span class="hljs-string">'s32'</span>, <span class="hljs-number">1</span>, {attr: <span class="hljs-string">"2"</span>})
|
||||
<span class="hljs-attribute">tag</span>: K.<span class="hljs-built_in">ITEM</span>(<span class="hljs-string">'s32'</span>, <span class="hljs-number">1</span>, {attr: <span class="hljs-string">"2"</span>})
|
||||
}</code></pre><p>Represents:</p>
|
||||
<pre><code><tag <span class="hljs-attribute">__type</span>=<span class="hljs-string">"s32"</span> <span class="hljs-attribute">attr</span>=<span class="hljs-string">"2"</span>>1</tag></code></pre>
|
||||
<pre><code><tag <span class="hljs-attribute">__type</span>=<span class="hljs-string">"s32"</span> <span class="hljs-attribute">attr</span>=<span class="hljs-string">"2"</span>>1</tag></code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -268,18 +295,18 @@
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>attribute map in addition to <strong>__type</strong></p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"str"</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L703">asphyxia-core.d.ts:703</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:770</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -291,15 +318,15 @@
|
||||
<h5>content: <span class="tsd-signature-type">Buffer</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"bin"</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L704">asphyxia-core.d.ts:704</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:771</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -311,15 +338,15 @@
|
||||
<h5>content: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"ip4"</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L705">asphyxia-core.d.ts:705</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:772</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -331,90 +358,114 @@
|
||||
<h5>content: <span class="tsd-signature-type">boolean</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"bool"</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L706">asphyxia-core.d.ts:706</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:773</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>S<span class="tsd-signature-symbol">: </span><a href="../index.html#knumbertype" class="tsd-signature-type">KNumberType</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>type: <a href="../globals.html#knumbertype" class="tsd-signature-type">KNumberType</a></h5>
|
||||
<h5>type: <span class="tsd-signature-type">S</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>content: <span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L707">asphyxia-core.d.ts:707</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:774</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>S<span class="tsd-signature-symbol">: </span><a href="../index.html#kbiginttype" class="tsd-signature-type">KBigIntType</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>type: <a href="../globals.html#kbiginttype" class="tsd-signature-type">KBigIntType</a></h5>
|
||||
<h5>type: <span class="tsd-signature-type">S</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>content: <span class="tsd-signature-type">bigint</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L708">asphyxia-core.d.ts:708</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:775</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>S<span class="tsd-signature-symbol">: </span><a href="../index.html#knumbergrouptype" class="tsd-signature-type">KNumberGroupType</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>type: <a href="../globals.html#knumbergrouptype" class="tsd-signature-type">KNumberGroupType</a></h5>
|
||||
<h5>type: <span class="tsd-signature-type">S</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>content: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L713">asphyxia-core.d.ts:713</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:776</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>S<span class="tsd-signature-symbol">: </span><a href="../index.html#kbigintgrouptype" class="tsd-signature-type">KBigIntGroupType</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>type: <a href="../globals.html#kbigintgrouptype" class="tsd-signature-type">KBigIntGroupType</a></h5>
|
||||
<h5>type: <span class="tsd-signature-type">S</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>content: <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attr: <a href="../index.html#kattrmap" class="tsd-signature-type">KAttrMap</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">KITEM</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -424,7 +475,7 @@
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="_.html">$</a>
|
||||
@@ -448,13 +499,13 @@
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<a href="k.html#array" class="tsd-kind-icon">ARRAY</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<a href="k.html#attr" class="tsd-kind-icon">ATTR</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
||||
<a href="k.html#item" class="tsd-kind-icon">ITEM</a>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -482,6 +533,5 @@
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
+55
-15
@@ -51,7 +51,7 @@
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="r.html">R</a>
|
||||
@@ -81,6 +81,7 @@
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#config" class="tsd-kind-icon">Config</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#contributor" class="tsd-kind-icon">Contributor</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#datafile" class="tsd-kind-icon">Data<wbr>File</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#gamecode" class="tsd-kind-icon">Game<wbr>Code</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#route" class="tsd-kind-icon">Route</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#unhandled" class="tsd-kind-icon">Unhandled</a></li>
|
||||
@@ -102,7 +103,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L295">asphyxia-core.d.ts:295</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:312</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -140,7 +141,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L285">asphyxia-core.d.ts:285</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:302</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -168,6 +169,43 @@
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a name="datafile" class="tsd-anchor"></a>
|
||||
<h3>Data<wbr>File</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">Data<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><a href="../interfaces/fileoption.html" class="tsd-signature-type">FileOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in asphyxia-core.d.ts:321</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Register a data file upload entry.</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 (with filename) where the uploaded file will be saved to.</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/fileoption.html" class="tsd-signature-type">FileOption</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>See <a href="../interfaces/fileoption.html">FileOption</a></p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a name="gamecode" class="tsd-anchor"></a>
|
||||
<h3>Game<wbr>Code</h3>
|
||||
@@ -178,7 +216,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L275">asphyxia-core.d.ts:275</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:292</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -205,13 +243,13 @@
|
||||
<a name="route" class="tsd-anchor"></a>
|
||||
<h3>Route</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">Route<span class="tsd-signature-symbol">(</span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><a href="../globals.html#eamusepluginroute" class="tsd-signature-type">EamusePluginRoute</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">Route<span class="tsd-signature-symbol">(</span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><a href="../index.html#eamusepluginroute" class="tsd-signature-type">EamusePluginRoute</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L254">asphyxia-core.d.ts:254</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:271</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -230,9 +268,9 @@
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <a href="../globals.html#eamusepluginroute" class="tsd-signature-type">EamusePluginRoute</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
|
||||
<h5>handler: <a href="../index.html#eamusepluginroute" class="tsd-signature-type">EamusePluginRoute</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Your custom route function/method following the type <a href="../globals.html#eamusepluginroute">EamusePluginRoute</a>.
|
||||
<p>Your custom route function/method following the type <a href="../index.html#eamusepluginroute">EamusePluginRoute</a>.
|
||||
A boolean can be passed if you don't need any processing:
|
||||
- <code>true</code>: Sending empty response with status code 0
|
||||
- <code>false</code>: Sending empty response with status code 1</p>
|
||||
@@ -247,13 +285,13 @@
|
||||
<a name="unhandled" class="tsd-anchor"></a>
|
||||
<h3>Unhandled</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||
<li class="tsd-signature tsd-kind-icon">Unhandled<span class="tsd-signature-symbol">(</span>handler<span class="tsd-signature-symbol">?: </span><a href="../globals.html#eamusepluginroute" class="tsd-signature-type">EamusePluginRoute</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">Unhandled<span class="tsd-signature-symbol">(</span>handler<span class="tsd-signature-symbol">?: </span><a href="../index.html#eamusepluginroute" class="tsd-signature-type">EamusePluginRoute</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L264">asphyxia-core.d.ts:264</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:281</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -265,9 +303,9 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> handler: <a href="../globals.html#eamusepluginroute" class="tsd-signature-type">EamusePluginRoute</a></h5>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> handler: <a href="../index.html#eamusepluginroute" class="tsd-signature-type">EamusePluginRoute</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Your custom route function/method following the type <a href="../globals.html#eamusepluginroute">EamusePluginRoute</a>.
|
||||
<p>Your custom route function/method following the type <a href="../index.html#eamusepluginroute">EamusePluginRoute</a>.
|
||||
If undefined, the router will apply a default handler that prints method names.</p>
|
||||
</div>
|
||||
</li>
|
||||
@@ -286,7 +324,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L304">asphyxia-core.d.ts:304</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:330</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -333,7 +371,7 @@
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="_.html">$</a>
|
||||
@@ -363,6 +401,9 @@
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a href="r.html#contributor" class="tsd-kind-icon">Contributor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a href="r.html#datafile" class="tsd-kind-icon">Data<wbr>File</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||
<a href="r.html#gamecode" class="tsd-kind-icon">Game<wbr>Code</a>
|
||||
</li>
|
||||
@@ -400,6 +441,5 @@
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
+74
-6
@@ -51,7 +51,7 @@
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="u.html">U</a>
|
||||
@@ -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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L864">asphyxia-core.d.ts:864</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L858">asphyxia-core.d.ts:858</a></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 <a href="https://github.com/asphyxia-core/plugins/blob/db46898/asphyxia-core.d.ts#L850">asphyxia-core.d.ts:850</a></li>
|
||||
<li>Defined in asphyxia-core.d.ts:916</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -193,7 +256,7 @@
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
<li class=" tsd-kind-namespace">
|
||||
<a href="_.html">$</a>
|
||||
@@ -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>
|
||||
@@ -251,6 +320,5 @@
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user