mirror of
https://github.com/asphyxia-core/asphyxia-core.github.io.git
synced 2026-03-21 17:25:23 -05:00
webui release
This commit is contained in:
Freddie
commit
d01b2f9a66
12
_config.yml
Normal file
12
_config.yml
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
theme: jekyll-theme-minimal
|
||||||
|
title: Asphyxia
|
||||||
|
logo: https://raw.githubusercontent.com/TsFreddie/asphyxia/master/docs/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="typedoc">Developer <strong>Docs</strong></a></li>
|
||||||
|
</ul>
|
||||||
|
include:
|
||||||
|
- typedoc
|
||||||
|
- _.html
|
||||||
3
_typedoc.md
Normal file
3
_typedoc.md
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
#### Asphyxia CORE
|
||||||
|
|
||||||
|
Quick Start guide coming soon.
|
||||||
BIN
img/core-logo.png
Normal file
BIN
img/core-logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
2679
typedoc/assets/css/main.css
Normal file
2679
typedoc/assets/css/main.css
Normal file
File diff suppressed because it is too large
Load Diff
BIN
typedoc/assets/images/icons.png
Normal file
BIN
typedoc/assets/images/icons.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.4 KiB |
BIN
typedoc/assets/images/icons@2x.png
Normal file
BIN
typedoc/assets/images/icons@2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
typedoc/assets/images/widgets.png
Normal file
BIN
typedoc/assets/images/widgets.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 480 B |
BIN
typedoc/assets/images/widgets@2x.png
Normal file
BIN
typedoc/assets/images/widgets@2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 855 B |
1
typedoc/assets/js/main.js
Normal file
1
typedoc/assets/js/main.js
Normal file
File diff suppressed because one or more lines are too long
1
typedoc/assets/js/search.json
Normal file
1
typedoc/assets/js/search.json
Normal file
File diff suppressed because one or more lines are too long
795
typedoc/classes/kdatareader.html
Normal file
795
typedoc/classes/kdatareader.html
Normal file
|
|
@ -0,0 +1,795 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html class="default no-js">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<title>KDataReader | 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>
|
||||||
|
<li>
|
||||||
|
<a href="kdatareader.html">KDataReader</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h1>Class KDataReader</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>A warpper of javascript object for reading xml-like formatted data.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-hierarchy">
|
||||||
|
<h3>Hierarchy</h3>
|
||||||
|
<ul class="tsd-hierarchy">
|
||||||
|
<li>
|
||||||
|
<span class="target">KDataReader</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>Constructors</h3>
|
||||||
|
<ul class="tsd-index-list">
|
||||||
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="kdatareader.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-index-section ">
|
||||||
|
<h3>Properties</h3>
|
||||||
|
<ul class="tsd-index-list">
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="kdatareader.html#obj" class="tsd-kind-icon">obj</a></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-index-section ">
|
||||||
|
<h3>Methods</h3>
|
||||||
|
<ul class="tsd-index-list">
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="kdatareader.html#attr" class="tsd-kind-icon">attr</a></li>
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="kdatareader.html#bigint" class="tsd-kind-icon">bigint</a></li>
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="kdatareader.html#bigints" class="tsd-kind-icon">bigints</a></li>
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="kdatareader.html#bool" class="tsd-kind-icon">bool</a></li>
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="kdatareader.html#buffer" class="tsd-kind-icon">buffer</a></li>
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="kdatareader.html#content" class="tsd-kind-icon">content</a></li>
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="kdatareader.html#element" class="tsd-kind-icon">element</a></li>
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="kdatareader.html#elements" class="tsd-kind-icon">elements</a></li>
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="kdatareader.html#number" class="tsd-kind-icon">number</a></li>
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="kdatareader.html#numbers" class="tsd-kind-icon">numbers</a></li>
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="kdatareader.html#str" class="tsd-kind-icon">str</a></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel-group tsd-member-group ">
|
||||||
|
<h2>Constructors</h2>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||||
|
<a name="constructor" class="tsd-anchor"></a>
|
||||||
|
<h3>constructor</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">new KData<wbr>Reader<span class="tsd-signature-symbol">(</span>obj<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><a href="kdatareader.html" class="tsd-signature-type">KDataReader</a></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:297</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>obj: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <a href="kdatareader.html" class="tsd-signature-type">KDataReader</a></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</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-class">
|
||||||
|
<a name="obj" class="tsd-anchor"></a>
|
||||||
|
<h3>obj</h3>
|
||||||
|
<div class="tsd-signature tsd-kind-icon">obj<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:297</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Wrapped javascript object</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel-group tsd-member-group ">
|
||||||
|
<h2>Methods</h2>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<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>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:330</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Get attrubutes 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>
|
||||||
|
<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">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>)
|
||||||
|
]
|
||||||
|
})
|
||||||
|
}</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>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a name="bigint" class="tsd-anchor"></a>
|
||||||
|
<h3>bigint</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">bigint<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, def<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bigint</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:363</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Get a bigint value from a tag, convert to bigint if applicable.</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>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>)
|
||||||
|
],
|
||||||
|
<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>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">bigint</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>Default return value when target path does
|
||||||
|
not exists or is not valid.</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a name="bigints" class="tsd-anchor"></a>
|
||||||
|
<h3>bigints</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">bigints<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, def<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bigint</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 asphyxia-core.d.ts:389</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>
|
||||||
|
</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">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>])
|
||||||
|
}</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>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a name="bool" class="tsd-anchor"></a>
|
||||||
|
<h3>bool</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">bool<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:417</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Get a boolean value from a tag, return true only if value in the tag is number and <strong>greater than zero</strong></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">"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>)
|
||||||
|
]
|
||||||
|
}</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>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</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-method tsd-parent-kind-class">
|
||||||
|
<a name="buffer" class="tsd-anchor"></a>
|
||||||
|
<h3>buffer</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">buffer<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, def<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:443</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Get a Buffer object from a tag, Only returns valid Buffer
|
||||||
|
when target tag has a type of "bin"</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">"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>])
|
||||||
|
}</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>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">Buffer</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a name="content" class="tsd-anchor"></a>
|
||||||
|
<h3>content</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">content<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, def<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>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:471</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Get raw content representation regardless of tag type</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">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>)
|
||||||
|
}</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>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a name="element" class="tsd-anchor"></a>
|
||||||
|
<h3>element</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">element<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="kdatareader.html" class="tsd-signature-type">KDataReader</a></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:503</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Get first element named <strong>path</strong> inside 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">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">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">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>) }
|
||||||
|
]
|
||||||
|
}</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>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <a href="kdatareader.html" class="tsd-signature-type">KDataReader</a></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a name="elements" class="tsd-anchor"></a>
|
||||||
|
<h3>elements</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">elements<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="kdatareader.html" class="tsd-signature-type">KDataReader</a><span class="tsd-signature-symbol">[]</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:534</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Get array of all elements named <strong>path</strong> inside 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">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">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">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>) }
|
||||||
|
]
|
||||||
|
}</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>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <a href="kdatareader.html" class="tsd-signature-type">KDataReader</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a name="number" class="tsd-anchor"></a>
|
||||||
|
<h3>number</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">number<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, def<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><span class="tsd-signature-type">number</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:567</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Get a number value from a tag, convert to number if applicable.</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>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>)
|
||||||
|
],
|
||||||
|
<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>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">number</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>Default return value when target path does
|
||||||
|
not exists or is not valid.</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a name="numbers" class="tsd-anchor"></a>
|
||||||
|
<h3>numbers</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">numbers<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, def<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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 asphyxia-core.d.ts:593</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>
|
||||||
|
</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">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>])
|
||||||
|
}</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>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a name="str" class="tsd-anchor"></a>
|
||||||
|
<h3>str</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">str<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, def<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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:619</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Get a string from a tag, Only returns valid string
|
||||||
|
when target tag has a type of "str"</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">"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>)
|
||||||
|
}</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>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
<nav class="tsd-navigation secondary menu-sticky">
|
||||||
|
<ul class="before-current">
|
||||||
|
</ul>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="current tsd-kind-class">
|
||||||
|
<a href="kdatareader.html" class="tsd-kind-icon">KData<wbr>Reader</a>
|
||||||
|
<ul>
|
||||||
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#obj" class="tsd-kind-icon">obj</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#attr" class="tsd-kind-icon">attr</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#bigint" class="tsd-kind-icon">bigint</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#bigints" class="tsd-kind-icon">bigints</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#bool" class="tsd-kind-icon">bool</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#buffer" class="tsd-kind-icon">buffer</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#content" class="tsd-kind-icon">content</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#element" class="tsd-kind-icon">element</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#elements" class="tsd-kind-icon">elements</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#number" class="tsd-kind-icon">number</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#numbers" class="tsd-kind-icon">numbers</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||||
|
<a href="kdatareader.html#str" class="tsd-kind-icon">str</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="after-current">
|
||||||
|
<li class=" tsd-kind-interface">
|
||||||
|
<a href="../interfaces/config_options.html" class="tsd-kind-icon">CONFIG_<wbr>OPTIONS</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>
|
||||||
344
typedoc/globals.html
Normal file
344
typedoc/globals.html
Normal file
|
|
@ -0,0 +1,344 @@
|
||||||
|
<!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/config_options.html" class="tsd-kind-icon">CONFIG_<wbr>OPTIONS</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 asphyxia-core.d.ts:217</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 asphyxia-core.d.ts:210</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:60</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:45</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:15</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:65</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:16</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:3</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/config_options.html" class="tsd-kind-icon">CONFIG_<wbr>OPTIONS</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>
|
||||||
165
typedoc/index.html
Normal file
165
typedoc/index.html
Normal file
|
|
@ -0,0 +1,165 @@
|
||||||
|
<!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">
|
||||||
|
<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>
|
||||||
|
</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>
|
||||||
|
<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/config_options.html" class="tsd-kind-icon">CONFIG_<wbr>OPTIONS</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>
|
||||||
353
typedoc/interfaces/config_options.html
Normal file
353
typedoc/interfaces/config_options.html
Normal file
|
|
@ -0,0 +1,353 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html class="default no-js">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<title>CONFIG_OPTIONS | 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>
|
||||||
|
<li>
|
||||||
|
<a href="config_options.html">CONFIG_OPTIONS</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h1>Interface CONFIG_OPTIONS</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>Detail of a config</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-hierarchy">
|
||||||
|
<h3>Hierarchy</h3>
|
||||||
|
<ul class="tsd-hierarchy">
|
||||||
|
<li>
|
||||||
|
<span class="target">CONFIG_OPTIONS</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="config_options.html#default" class="tsd-kind-icon">default</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="config_options.html#desc" class="tsd-kind-icon">desc</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="config_options.html#name" class="tsd-kind-icon">name</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="config_options.html#needrestart" class="tsd-kind-icon">need<wbr>Restart</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="config_options.html#options" class="tsd-kind-icon">options</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="config_options.html#range" class="tsd-kind-icon">range</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="config_options.html#type" class="tsd-kind-icon">type</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="config_options.html#validator" class="tsd-kind-icon">validator</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="default" class="tsd-anchor"></a>
|
||||||
|
<h3>default</h3>
|
||||||
|
<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 asphyxia-core.d.ts:95</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Default value of the option</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:83</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Provide a description for the option</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:81</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>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="needrestart" class="tsd-anchor"></a>
|
||||||
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> need<wbr>Restart</h3>
|
||||||
|
<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 asphyxia-core.d.ts:93</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Indicate whether user need to restart CORE to see changes.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="options" class="tsd-anchor"></a>
|
||||||
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> options</h3>
|
||||||
|
<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 asphyxia-core.d.ts:91</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Only applies to 'string', provide options in a dropdown menu.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="range" class="tsd-anchor"></a>
|
||||||
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> range</h3>
|
||||||
|
<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 asphyxia-core.d.ts:87</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Only applies to 'integer' and 'float'</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="type" class="tsd-anchor"></a>
|
||||||
|
<h3>type</h3>
|
||||||
|
<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 asphyxia-core.d.ts:85</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Type of the option</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="validator" class="tsd-anchor"></a>
|
||||||
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> validator</h3>
|
||||||
|
<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 asphyxia-core.d.ts:89</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Validator for notify user about invalid values. return <code>true</code> to pass the validation. return a string to send a error message to WebUI.</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-property">
|
||||||
|
<li class="tsd-signature tsd-kind-icon"><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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
|
</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>
|
||||||
|
</ul>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="current tsd-kind-interface">
|
||||||
|
<a href="config_options.html" class="tsd-kind-icon">CONFIG_<wbr>OPTIONS</a>
|
||||||
|
<ul>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="config_options.html#default" class="tsd-kind-icon">default</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="config_options.html#desc" class="tsd-kind-icon">desc</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="config_options.html#name" class="tsd-kind-icon">name</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="config_options.html#needrestart" class="tsd-kind-icon">need<wbr>Restart</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="config_options.html#options" class="tsd-kind-icon">options</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="config_options.html#range" class="tsd-kind-icon">range</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="config_options.html#type" class="tsd-kind-icon">type</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="config_options.html#validator" class="tsd-kind-icon">validator</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="after-current">
|
||||||
|
<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>
|
||||||
|
<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>
|
||||||
222
typedoc/interfaces/eamuseinfo.html
Normal file
222
typedoc/interfaces/eamuseinfo.html
Normal file
|
|
@ -0,0 +1,222 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html class="default no-js">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<title>EamuseInfo | 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>
|
||||||
|
<li>
|
||||||
|
<a href="eamuseinfo.html">EamuseInfo</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h1>Interface EamuseInfo</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>Information about requester</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-hierarchy">
|
||||||
|
<h3>Hierarchy</h3>
|
||||||
|
<ul class="tsd-hierarchy">
|
||||||
|
<li>
|
||||||
|
<span class="target">EamuseInfo</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="eamuseinfo.html#method" class="tsd-kind-icon">method</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamuseinfo.html#model" class="tsd-kind-icon">model</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamuseinfo.html#module" class="tsd-kind-icon">module</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="method" class="tsd-anchor"></a>
|
||||||
|
<h3>method</h3>
|
||||||
|
<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 asphyxia-core.d.ts:72</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="model" class="tsd-anchor"></a>
|
||||||
|
<h3>model</h3>
|
||||||
|
<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 asphyxia-core.d.ts:73</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="module" class="tsd-anchor"></a>
|
||||||
|
<h3>module</h3>
|
||||||
|
<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 asphyxia-core.d.ts:71</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 ">
|
||||||
|
<a href="../globals.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="config_options.html" class="tsd-kind-icon">CONFIG_<wbr>OPTIONS</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="current tsd-kind-interface">
|
||||||
|
<a href="eamuseinfo.html" class="tsd-kind-icon">Eamuse<wbr>Info</a>
|
||||||
|
<ul>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamuseinfo.html#method" class="tsd-kind-icon">method</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamuseinfo.html#model" class="tsd-kind-icon">model</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamuseinfo.html#module" class="tsd-kind-icon">module</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="after-current">
|
||||||
|
<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>
|
||||||
|
<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>
|
||||||
595
typedoc/interfaces/eamusesend.html
Normal file
595
typedoc/interfaces/eamusesend.html
Normal file
|
|
@ -0,0 +1,595 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html class="default no-js">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<title>EamuseSend | 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>
|
||||||
|
<li>
|
||||||
|
<a href="eamusesend.html">EamuseSend</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h1>Interface EamuseSend</h1>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
<div class="container container-main">
|
||||||
|
<div class="row">
|
||||||
|
<div class="col-8 col-content">
|
||||||
|
<section class="tsd-panel tsd-hierarchy">
|
||||||
|
<h3>Hierarchy</h3>
|
||||||
|
<ul class="tsd-hierarchy">
|
||||||
|
<li>
|
||||||
|
<span class="target">EamuseSend</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="eamusesend.html#deny" class="tsd-kind-icon">deny</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamusesend.html#object" class="tsd-kind-icon">object</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamusesend.html#pug" class="tsd-kind-icon">pug</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamusesend.html#pugfile" class="tsd-kind-icon">pug<wbr>File</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamusesend.html#status" class="tsd-kind-icon">status</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamusesend.html#success" class="tsd-kind-icon">success</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamusesend.html#xml" class="tsd-kind-icon">xml</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamusesend.html#xmlfile" class="tsd-kind-icon">xml<wbr>File</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="deny" class="tsd-anchor"></a>
|
||||||
|
<h3>deny</h3>
|
||||||
|
<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 asphyxia-core.d.ts:131</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Send empty response with status code 1</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-property">
|
||||||
|
<li class="tsd-signature tsd-kind-icon"><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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="object" class="tsd-anchor"></a>
|
||||||
|
<h3>object</h3>
|
||||||
|
<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 asphyxia-core.d.ts:164</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<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>)
|
||||||
|
})
|
||||||
|
}</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> },
|
||||||
|
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>]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}</code></pre>
|
||||||
|
<dl class="tsd-comment-tags">
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>xml-like formatted javascript object</p>
|
||||||
|
</dd>
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>Response options. See: <a href="eamusesendoption.html">EamuseSendOption</a></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</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-property">
|
||||||
|
<li class="tsd-signature tsd-kind-icon"><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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>res: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="pug" class="tsd-anchor"></a>
|
||||||
|
<h3>pug</h3>
|
||||||
|
<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 asphyxia-core.d.ts:184</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Send xml data using pug template system.</p>
|
||||||
|
</div>
|
||||||
|
<dl class="tsd-comment-tags">
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>pug string as the template</p>
|
||||||
|
</dd>
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>Render template with specified data,
|
||||||
|
pass null or undefined to render static xml</p>
|
||||||
|
</dd>
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>Response options. See: <a href="eamusesendoption.html">EamuseSendOption</a></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</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-property">
|
||||||
|
<li class="tsd-signature tsd-kind-icon"><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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>res: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="pugfile" class="tsd-anchor"></a>
|
||||||
|
<h3>pug<wbr>File</h3>
|
||||||
|
<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 asphyxia-core.d.ts:204</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Render and send pug template from a file</p>
|
||||||
|
</div>
|
||||||
|
<dl class="tsd-comment-tags">
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>Filename of the template</p>
|
||||||
|
</dd>
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>Render template with specified data,
|
||||||
|
pass null or undefined to render static xml</p>
|
||||||
|
</dd>
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>Response options. See: <a href="eamusesendoption.html">EamuseSendOption</a></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</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-property">
|
||||||
|
<li class="tsd-signature tsd-kind-icon"><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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="status" class="tsd-anchor"></a>
|
||||||
|
<h3>status</h3>
|
||||||
|
<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 asphyxia-core.d.ts:136</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Send empty response with custom status code</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-property">
|
||||||
|
<li class="tsd-signature tsd-kind-icon"><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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>code: <span class="tsd-signature-type">number</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="success" class="tsd-anchor"></a>
|
||||||
|
<h3>success</h3>
|
||||||
|
<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 asphyxia-core.d.ts:126</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Send empty response with status code 0</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-property">
|
||||||
|
<li class="tsd-signature tsd-kind-icon"><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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="xml" class="tsd-anchor"></a>
|
||||||
|
<h3>xml</h3>
|
||||||
|
<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 asphyxia-core.d.ts:174</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Send xml data using ejs template system.</p>
|
||||||
|
</div>
|
||||||
|
<dl class="tsd-comment-tags">
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>xml string as the template</p>
|
||||||
|
</dd>
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>Render template with specified data,
|
||||||
|
pass null or undefined to render static xml</p>
|
||||||
|
</dd>
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>Response options. See: <a href="eamusesendoption.html">EamuseSendOption</a></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</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-property">
|
||||||
|
<li class="tsd-signature tsd-kind-icon"><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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>res: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="xmlfile" class="tsd-anchor"></a>
|
||||||
|
<h3>xml<wbr>File</h3>
|
||||||
|
<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 asphyxia-core.d.ts:194</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Render and send ejs template from a file</p>
|
||||||
|
</div>
|
||||||
|
<dl class="tsd-comment-tags">
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>Filename of the template</p>
|
||||||
|
</dd>
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>Render template with specified data,
|
||||||
|
pass null or undefined to render static xml</p>
|
||||||
|
</dd>
|
||||||
|
<dt>param</dt>
|
||||||
|
<dd><p>Response options. See: <a href="eamusesendoption.html">EamuseSendOption</a></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</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-property">
|
||||||
|
<li class="tsd-signature tsd-kind-icon"><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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>file: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
|
</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="config_options.html" class="tsd-kind-icon">CONFIG_<wbr>OPTIONS</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-interface">
|
||||||
|
<a href="eamuseinfo.html" class="tsd-kind-icon">Eamuse<wbr>Info</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="current tsd-kind-interface">
|
||||||
|
<a href="eamusesend.html" class="tsd-kind-icon">Eamuse<wbr>Send</a>
|
||||||
|
<ul>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesend.html#deny" class="tsd-kind-icon">deny</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesend.html#object" class="tsd-kind-icon">object</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesend.html#pug" class="tsd-kind-icon">pug</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesend.html#pugfile" class="tsd-kind-icon">pug<wbr>File</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesend.html#status" class="tsd-kind-icon">status</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesend.html#success" class="tsd-kind-icon">success</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesend.html#xml" class="tsd-kind-icon">xml</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesend.html#xmlfile" class="tsd-kind-icon">xml<wbr>File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="after-current">
|
||||||
|
<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>
|
||||||
|
<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>
|
||||||
277
typedoc/interfaces/eamusesendoption.html
Normal file
277
typedoc/interfaces/eamusesendoption.html
Normal file
|
|
@ -0,0 +1,277 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html class="default no-js">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<title>EamuseSendOption | 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>
|
||||||
|
<li>
|
||||||
|
<a href="eamusesendoption.html">EamuseSendOption</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h1>Interface EamuseSendOption</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>Response options</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-hierarchy">
|
||||||
|
<h3>Hierarchy</h3>
|
||||||
|
<ul class="tsd-hierarchy">
|
||||||
|
<li>
|
||||||
|
<span class="target">EamuseSendOption</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="eamusesendoption.html#compress" class="tsd-kind-icon">compress</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamusesendoption.html#encoding" class="tsd-kind-icon">encoding</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamusesendoption.html#encrypt" class="tsd-kind-icon">encrypt</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamusesendoption.html#kencode" class="tsd-kind-icon">kencode</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamusesendoption.html#rootname" class="tsd-kind-icon">root<wbr>Name</a></li>
|
||||||
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="eamusesendoption.html#status" class="tsd-kind-icon">status</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="compress" class="tsd-anchor"></a>
|
||||||
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> compress</h3>
|
||||||
|
<div class="tsd-signature tsd-kind-icon">compress<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:117</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>
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:108</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Encode response with specified encoding
|
||||||
|
Default: 'SHIFT_JIS'</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="encrypt" class="tsd-anchor"></a>
|
||||||
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> encrypt</h3>
|
||||||
|
<div class="tsd-signature tsd-kind-icon">encrypt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:119</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="kencode" class="tsd-anchor"></a>
|
||||||
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> kencode</h3>
|
||||||
|
<div class="tsd-signature tsd-kind-icon">kencode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:118</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="rootname" class="tsd-anchor"></a>
|
||||||
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> root<wbr>Name</h3>
|
||||||
|
<div class="tsd-signature tsd-kind-icon">root<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:115</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Replace response root tag name.
|
||||||
|
Default to child tag name of request <call> tag,
|
||||||
|
which is usually the case and don't need to be replaced.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a name="status" class="tsd-anchor"></a>
|
||||||
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
|
||||||
|
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:102</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 ">
|
||||||
|
<a href="../globals.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="config_options.html" class="tsd-kind-icon">CONFIG_<wbr>OPTIONS</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>
|
||||||
|
</ul>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="current tsd-kind-interface">
|
||||||
|
<a href="eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
|
||||||
|
<ul>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesendoption.html#compress" class="tsd-kind-icon">compress</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesendoption.html#encoding" class="tsd-kind-icon">encoding</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesendoption.html#encrypt" class="tsd-kind-icon">encrypt</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesendoption.html#kencode" class="tsd-kind-icon">kencode</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesendoption.html#rootname" class="tsd-kind-icon">root<wbr>Name</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
|
<a href="eamusesendoption.html#status" class="tsd-kind-icon">status</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="after-current">
|
||||||
|
<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>
|
||||||
522
typedoc/modules/_.html
Normal file
522
typedoc/modules/_.html
Normal file
|
|
@ -0,0 +1,522 @@
|
||||||
|
<!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>
|
||||||
|
<li>
|
||||||
|
<a href="_.html">$</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h1>Namespace $</h1>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
<div class="container container-main">
|
||||||
|
<div class="row">
|
||||||
|
<div class="col-8 col-content">
|
||||||
|
<section class="tsd-panel">
|
||||||
|
<h3 class="tsd-before-signature">Callable</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">$<span class="tsd-signature-symbol">(</span>data<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><a href="../classes/kdatareader.html" class="tsd-signature-type">KDataReader</a></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:625</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Helper for reading xml-like formatted data.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <a href="../classes/kdatareader.html" class="tsd-signature-type">KDataReader</a></h4>
|
||||||
|
</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>Functions</h3>
|
||||||
|
<ul class="tsd-index-list">
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="_.html#attr" class="tsd-kind-icon">ATTR</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="_.html#bigint" class="tsd-kind-icon">BIGINT</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="_.html#bigints" class="tsd-kind-icon">BIGINTS</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="_.html#bool" class="tsd-kind-icon">BOOL</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="_.html#buffer" class="tsd-kind-icon">BUFFER</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="_.html#content" class="tsd-kind-icon">CONTENT</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="_.html#element" class="tsd-kind-icon">ELEMENT</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="_.html#elements" class="tsd-kind-icon">ELEMENTS</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="_.html#number" class="tsd-kind-icon">NUMBER</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="_.html#numbers" class="tsd-kind-icon">NUMBERS</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="_.html#str" class="tsd-kind-icon">STR</a></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</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="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>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:627</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="bigint" class="tsd-anchor"></a>
|
||||||
|
<h3>BIGINT</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">BIGINT<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>, def<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bigint</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:628</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">bigint</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="bigints" class="tsd-anchor"></a>
|
||||||
|
<h3>BIGINTS</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">BIGINTS<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>, def<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bigint</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 asphyxia-core.d.ts:629</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="bool" class="tsd-anchor"></a>
|
||||||
|
<h3>BOOL</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">BOOL<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><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:630</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</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="buffer" class="tsd-anchor"></a>
|
||||||
|
<h3>BUFFER</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">BUFFER<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>, def<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:631</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">Buffer</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="content" class="tsd-anchor"></a>
|
||||||
|
<h3>CONTENT</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">CONTENT<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>, def<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>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:632</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="element" class="tsd-anchor"></a>
|
||||||
|
<h3>ELEMENT</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">ELEMENT<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>, def<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>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:633</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="elements" class="tsd-anchor"></a>
|
||||||
|
<h3>ELEMENTS</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">ELEMENTS<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>, def<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>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:634</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="number" class="tsd-anchor"></a>
|
||||||
|
<h3>NUMBER</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">NUMBER<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>, def<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><span class="tsd-signature-type">number</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:635</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">number</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="numbers" class="tsd-anchor"></a>
|
||||||
|
<h3>NUMBERS</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">NUMBERS<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>, def<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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 asphyxia-core.d.ts:636</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="str" class="tsd-anchor"></a>
|
||||||
|
<h3>STR</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">STR<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>, def<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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:637</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> def: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
|
<li class="current tsd-kind-namespace">
|
||||||
|
<a href="_.html">$</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="db.html">DB</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="io.html">IO</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="k.html">K</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="r.html">R</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="u.html">U</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
<nav class="tsd-navigation secondary menu-sticky">
|
||||||
|
<ul class="before-current">
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="_.html#attr" class="tsd-kind-icon">ATTR</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="_.html#bigint" class="tsd-kind-icon">BIGINT</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="_.html#bigints" class="tsd-kind-icon">BIGINTS</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="_.html#bool" class="tsd-kind-icon">BOOL</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="_.html#buffer" class="tsd-kind-icon">BUFFER</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="_.html#content" class="tsd-kind-icon">CONTENT</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="_.html#element" class="tsd-kind-icon">ELEMENT</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="_.html#elements" class="tsd-kind-icon">ELEMENTS</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="_.html#number" class="tsd-kind-icon">NUMBER</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="_.html#numbers" class="tsd-kind-icon">NUMBERS</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="_.html#str" class="tsd-kind-icon">STR</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>
|
||||||
482
typedoc/modules/db.html
Normal file
482
typedoc/modules/db.html
Normal file
|
|
@ -0,0 +1,482 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html class="default no-js">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<title>DB | 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>
|
||||||
|
<li>
|
||||||
|
<a href="db.html">DB</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h1>Namespace DB</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>Database operation.</p>
|
||||||
|
</div>
|
||||||
|
<p>There are two pools of data for each plugin: <strong><em>PluginSpace</em></strong> and <strong>ProfileSpace</strong></p>
|
||||||
|
<p>If <code>refid</code> is a string, query will match a specific profile data in <strong>ProfileSpace</strong>.</p>
|
||||||
|
<p>If <code>refid</code> is null, query will match all profile data in <strong>ProfileSpace</strong>.
|
||||||
|
(doesn't apply to <a href="db.html#findone">DB.FindOne</a> and <a href="db.html#insert">DB.Insert</a>)</p>
|
||||||
|
<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>
|
||||||
|
<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>
|
||||||
|
</div>
|
||||||
|
</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>Functions</h3>
|
||||||
|
<ul class="tsd-index-list">
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="db.html#count" class="tsd-kind-icon">Count</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="db.html#find" class="tsd-kind-icon">Find</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="db.html#findone" class="tsd-kind-icon">Find<wbr>One</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="db.html#insert" class="tsd-kind-icon">Insert</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="db.html#remove" class="tsd-kind-icon">Remove</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="db.html#update" class="tsd-kind-icon">Update</a></li>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="db.html#upsert" class="tsd-kind-icon">Upsert</a></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</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="count" class="tsd-anchor"></a>
|
||||||
|
<h3>Count</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Count<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">object</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">number</span><span class="tsd-signature-symbol">></span></li>
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Count<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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">number</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 asphyxia-core.d.ts:897</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>query: <span class="tsd-signature-type">object</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">number</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:898</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>query: <span class="tsd-signature-type">object</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">number</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="find" class="tsd-anchor"></a>
|
||||||
|
<h3>Find</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Find<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">object</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">any</span><span class="tsd-signature-symbol">></span></li>
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Find<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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">any</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 asphyxia-core.d.ts:854</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>query: <span class="tsd-signature-type">object</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">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:855</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>query: <span class="tsd-signature-type">object</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">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="findone" class="tsd-anchor"></a>
|
||||||
|
<h3>Find<wbr>One</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Find<wbr>One<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">object</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">any</span><span class="tsd-signature-symbol">></span></li>
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Find<wbr>One<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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">any</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 asphyxia-core.d.ts:851</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>refid: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>query: <span class="tsd-signature-type">object</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">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:852</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>query: <span class="tsd-signature-type">object</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">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="insert" class="tsd-anchor"></a>
|
||||||
|
<h3>Insert</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Insert<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">object</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">any</span><span class="tsd-signature-symbol">></span></li>
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Insert<span class="tsd-signature-symbol">(</span>doc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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">any</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 asphyxia-core.d.ts:857</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>refid: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>doc: <span class="tsd-signature-type">object</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">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:858</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>doc: <span class="tsd-signature-type">object</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">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="remove" class="tsd-anchor"></a>
|
||||||
|
<h3>Remove</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Remove<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">object</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">number</span><span class="tsd-signature-symbol">></span></li>
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Remove<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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">number</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 asphyxia-core.d.ts:860</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>query: <span class="tsd-signature-type">object</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">number</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:861</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>query: <span class="tsd-signature-type">object</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">number</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="update" class="tsd-anchor"></a>
|
||||||
|
<h3>Update</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Update<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">object</span>, update<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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">any</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<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, update<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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">any</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 asphyxia-core.d.ts:863</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>query: <span class="tsd-signature-type">object</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>update: <span class="tsd-signature-type">object</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">any</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 asphyxia-core.d.ts:871</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>query: <span class="tsd-signature-type">object</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>update: <span class="tsd-signature-type">object</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">any</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>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="upsert" class="tsd-anchor"></a>
|
||||||
|
<h3>Upsert</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Upsert<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">object</span>, update<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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">any</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<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, update<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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">any</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 asphyxia-core.d.ts:879</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>query: <span class="tsd-signature-type">object</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>update: <span class="tsd-signature-type">object</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">any</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 asphyxia-core.d.ts:888</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>query: <span class="tsd-signature-type">object</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>update: <span class="tsd-signature-type">object</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">any</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>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="_.html">$</a>
|
||||||
|
</li>
|
||||||
|
<li class="current tsd-kind-namespace">
|
||||||
|
<a href="db.html">DB</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="io.html">IO</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="k.html">K</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="r.html">R</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="u.html">U</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
<nav class="tsd-navigation secondary menu-sticky">
|
||||||
|
<ul class="before-current">
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="db.html#count" class="tsd-kind-icon">Count</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="db.html#find" class="tsd-kind-icon">Find</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="db.html#findone" class="tsd-kind-icon">Find<wbr>One</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="db.html#insert" class="tsd-kind-icon">Insert</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="db.html#remove" class="tsd-kind-icon">Remove</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="db.html#update" class="tsd-kind-icon">Update</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="db.html#upsert" class="tsd-kind-icon">Upsert</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>
|
||||||
427
typedoc/modules/io.html
Normal file
427
typedoc/modules/io.html
Normal file
|
|
@ -0,0 +1,427 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html class="default no-js">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<title>IO | 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>
|
||||||
|
<li>
|
||||||
|
<a href="io.html">IO</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h1>Namespace IO</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>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><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>
|
||||||
|
</div>
|
||||||
|
</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>Functions</h3>
|
||||||
|
<ul class="tsd-index-list">
|
||||||
|
<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>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="io.html#writefile" class="tsd-kind-icon">Write<wbr>File</a></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</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="readdir" class="tsd-anchor"></a>
|
||||||
|
<h3>Read<wbr>Dir</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Read<wbr>Dir<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-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"file"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dir"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"unsupported"</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 asphyxia-core.d.ts:731</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Asynchronously read a directory.</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 directory.</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-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"file"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dir"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"unsupported"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<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>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:765</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Asynchronously reads the entire contents of a file.</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.
|
||||||
|
If a file descriptor is provided, the underlying file will <em>not</em> be closed automatically.</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>options: <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></h5>
|
||||||
|
<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>
|
||||||
|
</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>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:777</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Asynchronously reads the entire contents of a file.</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.
|
||||||
|
If a file descriptor is provided, the underlying file will <em>not</em> be closed automatically.</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>options: <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></h5>
|
||||||
|
<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>
|
||||||
|
</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>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:789</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Asynchronously reads the entire contents of a file.</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.
|
||||||
|
If a file descriptor is provided, the underlying file will <em>not</em> be closed automatically.</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>options: <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></h5>
|
||||||
|
<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>
|
||||||
|
</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>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:799</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Asynchronously reads the entire contents of a file.</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.
|
||||||
|
If a file descriptor is provided, the underlying file will <em>not</em> be closed automatically.</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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="resolve" class="tsd-anchor"></a>
|
||||||
|
<h3>Resolve</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Resolve<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">string</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:725</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Resolve a relative path starting from your plugin directory to an absolute path.</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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="writefile" class="tsd-anchor"></a>
|
||||||
|
<h3>Write<wbr>File</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Write<wbr>File<span class="tsd-signature-symbol">(</span>path<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><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>mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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">string</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">void</span><span class="tsd-signature-symbol">></span></li>
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Write<wbr>File<span class="tsd-signature-symbol">(</span>path<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><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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:744</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Asynchronously writes data to a file, replacing the file if it already exists.</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.
|
||||||
|
If a file descriptor is provided, the underlying file will <em>not</em> be closed automatically.</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string.</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>options: <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>mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag.
|
||||||
|
If <code>encoding</code> is not supplied, the default of <code>'utf8'</code> is used.
|
||||||
|
If <code>mode</code> is not supplied, the default of <code>0o666</code> is used.
|
||||||
|
If <code>mode</code> is a string, it is parsed as an octal integer.
|
||||||
|
If <code>flag</code> is not supplied, the default of <code>'w'</code> is used.</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:756</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Asynchronously writes data to a file, replacing the file if it already exists.</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.
|
||||||
|
If a file descriptor is provided, the underlying file will <em>not</em> be closed automatically.</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string.</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">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="_.html">$</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="db.html">DB</a>
|
||||||
|
</li>
|
||||||
|
<li class="current tsd-kind-namespace">
|
||||||
|
<a href="io.html">IO</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="k.html">K</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="r.html">R</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="u.html">U</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</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#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>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="io.html#writefile" class="tsd-kind-icon">Write<wbr>File</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>
|
||||||
487
typedoc/modules/k.html
Normal file
487
typedoc/modules/k.html
Normal file
|
|
@ -0,0 +1,487 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html class="default no-js">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<title>K | 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>
|
||||||
|
<li>
|
||||||
|
<a href="k.html">K</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h1>Namespace K</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>K stands for <code>Konstruct</code></p>
|
||||||
|
</div>
|
||||||
|
<p>Helper for constructing xml-like javascript object.</p>
|
||||||
|
</div>
|
||||||
|
</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>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>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</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="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>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:706</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>})
|
||||||
|
}</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>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<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>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p><strong>__type</strong> attribute, which is used during encoding and compression</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>content: <span class="tsd-signature-type">Buffer</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>array of data, <strong>__count</strong> attribute will be automatically set to <code>content.length</code></p>
|
||||||
|
</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>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:707</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<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>
|
||||||
|
</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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:708</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<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>
|
||||||
|
</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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<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>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:665</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>}, {
|
||||||
|
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>
|
||||||
|
<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-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>attr: <a href="../globals.html#kattrmap" class="tsd-signature-type">KAttrMap</a></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>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<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>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:682</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>})
|
||||||
|
}</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>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>type: <span class="tsd-signature-type">"str"</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p><strong>__type</strong> attribute, which is used during encoding and compression</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>content: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>data of specified type</p>
|
||||||
|
</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>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:683</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>type: <span class="tsd-signature-type">"bin"</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:684</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>type: <span class="tsd-signature-type">"ip4"</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:685</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>type: <span class="tsd-signature-type">"bool"</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:686</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<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>
|
||||||
|
</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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:687</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<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>
|
||||||
|
</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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:688</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<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>
|
||||||
|
</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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:689</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<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>
|
||||||
|
</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>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="_.html">$</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="db.html">DB</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="io.html">IO</a>
|
||||||
|
</li>
|
||||||
|
<li class="current tsd-kind-namespace">
|
||||||
|
<a href="k.html">K</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="r.html">R</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="u.html">U</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
<nav class="tsd-navigation secondary menu-sticky">
|
||||||
|
<ul class="before-current">
|
||||||
|
<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>
|
||||||
|
</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>
|
||||||
405
typedoc/modules/r.html
Normal file
405
typedoc/modules/r.html
Normal file
|
|
@ -0,0 +1,405 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html class="default no-js">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<title>R | 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>
|
||||||
|
<li>
|
||||||
|
<a href="r.html">R</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h1>Namespace R</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>R stands for <code>Register</code></p>
|
||||||
|
</div>
|
||||||
|
<p>These functions can only be called in plugins' <code>register()</code> function.</p>
|
||||||
|
</div>
|
||||||
|
</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>Functions</h3>
|
||||||
|
<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#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>
|
||||||
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#webuievent" class="tsd-kind-icon">WebUIEvent</a></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</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="config" class="tsd-anchor"></a>
|
||||||
|
<h3>Config</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Config<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/config_options.html" class="tsd-signature-type">CONFIG_OPTIONS</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:278</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Register a configuration option.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>key: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>config key</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>options: <a href="../interfaces/config_options.html" class="tsd-signature-type">CONFIG_OPTIONS</a></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>See <a href="../interfaces/config_options.html">CONFIG_OPTIONS</a></p>
|
||||||
|
<p><strong>NOTE</strong>: <code>options.validator</code> will only notify user about invalid value. It wouldn't stop user from saving invalid value.</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="contributor" class="tsd-anchor"></a>
|
||||||
|
<h3>Contributor</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Contributor<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, link<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">void</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:268</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Register a contributor.</p>
|
||||||
|
</div>
|
||||||
|
<p>Contributors will show up in WebUI.</p>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>Contributor's name</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> link: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>Contributor's homepage</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>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Game<wbr>Code<span class="tsd-signature-symbol">(</span>code<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">void</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:258</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Register a target game code to your plugin for checking savedata.</p>
|
||||||
|
</div>
|
||||||
|
<p>You should only call this from your plugin's <code>register()</code> function.</p>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>code: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>Model code of your target machine,
|
||||||
|
usually <strong>three capital letters</strong></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="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>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:237</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Register your custom route.</p>
|
||||||
|
</div>
|
||||||
|
<p>You should only call this from your plugin's <code>register()</code> function.</p>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>method: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>Method name of your target route,
|
||||||
|
usually looks like <code>"module.get"</code></p>
|
||||||
|
</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>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>Your custom route function/method following the type <a href="../globals.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>
|
||||||
|
</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="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>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:247</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Register all unhandled routes for a game.</p>
|
||||||
|
</div>
|
||||||
|
<p>You should only call this from your plugin's <code>register()</code> function.</p>
|
||||||
|
</div>
|
||||||
|
<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>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>Your custom route function/method following the type <a href="../globals.html#eamusepluginroute">EamusePluginRoute</a>.
|
||||||
|
If undefined, the router will apply a default handler that prints method names.</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="webuievent" class="tsd-anchor"></a>
|
||||||
|
<h3>WebUIEvent</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">WebUIEvent<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>data<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">void</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><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:287</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Register a WebUI event callback</p>
|
||||||
|
</div>
|
||||||
|
<p>Which can be called in WebUI using <code>emit(event)</code> function or a post message to <code>/emit/<event></code></p>
|
||||||
|
<p>Callback can be async function if you want to use await for your DB operations.</p>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>event: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5>callback: <span class="tsd-signature-symbol">(</span>data<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">void</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></h5>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li class="tsd-parameter-signature">
|
||||||
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
||||||
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>data<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">void</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></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="_.html">$</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="db.html">DB</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="io.html">IO</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="k.html">K</a>
|
||||||
|
</li>
|
||||||
|
<li class="current tsd-kind-namespace">
|
||||||
|
<a href="r.html">R</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="u.html">U</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
<nav class="tsd-navigation secondary menu-sticky">
|
||||||
|
<ul class="before-current">
|
||||||
|
<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#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>
|
||||||
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a href="r.html#webuievent" class="tsd-kind-icon">WebUIEvent</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>
|
||||||
256
typedoc/modules/u.html
Normal file
256
typedoc/modules/u.html
Normal file
|
|
@ -0,0 +1,256 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html class="default no-js">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<title>U | 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>
|
||||||
|
<li>
|
||||||
|
<a href="u.html">U</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h1>Namespace U</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>U stands for <code>Utilities</code></p>
|
||||||
|
</div>
|
||||||
|
<p>You can find miscellaneous helpers here</p>
|
||||||
|
</div>
|
||||||
|
</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>Functions</h3>
|
||||||
|
<ul class="tsd-index-list">
|
||||||
|
<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#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>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</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="getconfig" class="tsd-anchor"></a>
|
||||||
|
<h3>Get<wbr>Config</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">Get<wbr>Config<span class="tsd-signature-symbol">(</span>key<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">any</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:827</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Get config from user configuration file.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>key: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</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>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">parseXML<span class="tsd-signature-symbol">(</span>xml<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, simplify<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">any</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:821</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Convert xml string to javascript object. Output will always be plain javascript string.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>xml: <span class="tsd-signature-type">string</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>xml string</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> simplify: <span class="tsd-signature-type">boolean</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>if true, the parser will ignore attributes and only generate string values. (default: true)</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<a name="toxml" class="tsd-anchor"></a>
|
||||||
|
<h3>toXML</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">toXML<span class="tsd-signature-symbol">(</span>data<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">string</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in asphyxia-core.d.ts:813</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Convert json data to xml string.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<p>xml-like javascript object</p>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="_.html">$</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="db.html">DB</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="io.html">IO</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="k.html">K</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-namespace">
|
||||||
|
<a href="r.html">R</a>
|
||||||
|
</li>
|
||||||
|
<li class="current tsd-kind-namespace">
|
||||||
|
<a href="u.html">U</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</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#getconfig" class="tsd-kind-icon">Get<wbr>Config</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>
|
||||||
|
</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>
|
||||||
Loading…
Reference in New Issue
Block a user