npm-packages/rpclibrary
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

test checkin docs

Browse Source
This commit is contained in:
peter
2019-09-22 10:09:04 +02:00
parent a0611d2de3
commit 2e311e4881
30 changed files with 1225 additions and 6413 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/modules/_backend_.html
-183
View File
@@ -1,183 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>&quot;Backend&quot; | rpclibrary</title>
<meta name="description" content="">
<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.js" 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">rpclibrary</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-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">Globals</a>
</li>
<li>
<a href="_backend_.html">&quot;Backend&quot;</a>
</li>
</ul>
<h1>External module &quot;Backend&quot;</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>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter"><a href="../classes/_backend_.rpcserver.html" class="tsd-kind-icon">RPCServer</a></li>
</ul>
</section>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../index.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-external-module">
<a href="_backend_.html">"<wbr>Backend"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_frontend_.html">"<wbr>Frontend"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_interfaces_.html">"<wbr>Interfaces"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_types_.html">"<wbr>Types"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_utils_.html">"<wbr>Utils"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../classes/_backend_.rpcserver.html" class="tsd-kind-icon">RPCServer</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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>
docs/modules/_backend_.md
+9
View File
@@ -0,0 +1,9 @@
[rpclibrary](../README.md) › ["Backend"](_backend_.md)
# External module: "Backend"
## Index
### Classes
* [RPCServer](../classes/_backend_.rpcserver.md)
docs/modules/_frontend_.html
-218
View File
@@ -1,218 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>&quot;Frontend&quot; | rpclibrary</title>
<meta name="description" content="">
<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.js" 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">rpclibrary</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-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">Globals</a>
</li>
<li>
<a href="_frontend_.html">&quot;Frontend&quot;</a>
</li>
</ul>
<h1>External module &quot;Frontend&quot;</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>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_frontend_.rpcsocket.html" class="tsd-kind-icon">RPCSocket</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_frontend_.html#stripafterequals" class="tsd-kind-icon">strip<wbr>After<wbr>Equals</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a name="stripafterequals" class="tsd-anchor"></a>
<h3>strip<wbr>After<wbr>Equals</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">strip<wbr>After<wbr>Equals<span class="tsd-signature-symbol">(</span>str<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 Frontend.ts:9</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>str: <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="../index.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="_backend_.html">"<wbr>Backend"</a>
</li>
<li class="current tsd-kind-external-module">
<a href="_frontend_.html">"<wbr>Frontend"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_interfaces_.html">"<wbr>Interfaces"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_types_.html">"<wbr>Types"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_utils_.html">"<wbr>Utils"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="../classes/_frontend_.rpcsocket.html" class="tsd-kind-icon">RPCSocket</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_frontend_.html#stripafterequals" class="tsd-kind-icon">strip<wbr>After<wbr>Equals</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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>
docs/modules/_frontend_.md
+29
View File
@@ -0,0 +1,29 @@
[rpclibrary](../README.md) › ["Frontend"](_frontend_.md)
# External module: "Frontend"
## Index
### Classes
* [RPCSocket](../classes/_frontend_.rpcsocket.md)
### Functions
* [stripAfterEquals](_frontend_.md#stripafterequals)
## Functions
### stripAfterEquals
▸ **stripAfterEquals**(`str`: string): *string*
Defined in Frontend.ts:9
**Parameters:**
Name | Type |
------ | ------ |
`str` | string |
**Returns:** *string*
docs/modules/_interfaces_.html
-191
View File
@@ -1,191 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>&quot;Interfaces&quot; | rpclibrary</title>
<meta name="description" content="">
<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.js" 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">rpclibrary</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-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">Globals</a>
</li>
<li>
<a href="_interfaces_.html">&quot;Interfaces&quot;</a>
</li>
</ul>
<h1>External module &quot;Interfaces&quot;</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>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_interfaces_.destroyable.html" class="tsd-kind-icon">Destroyable</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter"><a href="../interfaces/_interfaces_.exporter.html" class="tsd-kind-icon">Exporter</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_interfaces_.socket.html" class="tsd-kind-icon">Socket</a></li>
</ul>
</section>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../index.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="_backend_.html">"<wbr>Backend"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_frontend_.html">"<wbr>Frontend"</a>
</li>
<li class="current tsd-kind-external-module">
<a href="_interfaces_.html">"<wbr>Interfaces"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_types_.html">"<wbr>Types"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_utils_.html">"<wbr>Utils"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_interfaces_.destroyable.html" class="tsd-kind-icon">Destroyable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../interfaces/_interfaces_.exporter.html" class="tsd-kind-icon">Exporter</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_interfaces_.socket.html" class="tsd-kind-icon">Socket</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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>
docs/modules/_interfaces_.md
+11
View File
@@ -0,0 +1,11 @@
[rpclibrary](../README.md) › ["Interfaces"](_interfaces_.md)
# External module: "Interfaces"
## Index
### Interfaces
* [Destroyable](../interfaces/_interfaces_.destroyable.md)
* [Exporter](../interfaces/_interfaces_.exporter.md)
* [Socket](../interfaces/_interfaces_.socket.md)
docs/modules/_types_.html
-885
View File
@@ -1,885 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>&quot;Types&quot; | rpclibrary</title>
<meta name="description" content="">
<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.js" 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">rpclibrary</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-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">Globals</a>
</li>
<li>
<a href="_types_.html">&quot;Types&quot;</a>
</li>
</ul>
<h1>External module &quot;Types&quot;</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>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#any" class="tsd-kind-icon">Any</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#arg" class="tsd-kind-icon">Arg</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#asyncfunction" class="tsd-kind-icon">Async<wbr>Function</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#baseinfo" class="tsd-kind-icon">Base<wbr>Info</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#callinfo" class="tsd-kind-icon">Call<wbr>Info</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#callrpc" class="tsd-kind-icon">CallRPC</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#callbackfunction" class="tsd-kind-icon">Callback<wbr>Function</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#closehandler" class="tsd-kind-icon">Close<wbr>Handler</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#connectionhandler" class="tsd-kind-icon">Connection<wbr>Handler</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#errorhandler" class="tsd-kind-icon">Error<wbr>Handler</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#errorresponse" class="tsd-kind-icon">Error<wbr>Response</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#extendedrpcinfo" class="tsd-kind-icon">Extended<wbr>Rpc<wbr>Info</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#hookclosefunction" class="tsd-kind-icon">Hook<wbr>Close<wbr>Function</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#hookfunction" class="tsd-kind-icon">Hook<wbr>Function</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#hookinfo" class="tsd-kind-icon">Hook<wbr>Info</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#hookrpc" class="tsd-kind-icon">HookRPC</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#name-2" class="tsd-kind-icon">Name</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#onfunction" class="tsd-kind-icon">On<wbr>Function</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#outcome" class="tsd-kind-icon">Outcome</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#owner-1" class="tsd-kind-icon">Owner</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#rpc" class="tsd-kind-icon">RPC</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#rpctype" class="tsd-kind-icon">RPCType</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#responsetype" class="tsd-kind-icon">Response<wbr>Type</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#respose" class="tsd-kind-icon">Respose</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#rpcinfo" class="tsd-kind-icon">Rpc<wbr>Info</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#socketconf" class="tsd-kind-icon">Socket<wbr>Conf</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#subscriptionresponse" class="tsd-kind-icon">Subscription<wbr>Response</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_types_.html#successresponse" class="tsd-kind-icon">Success<wbr>Response</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_types_.html#visibility-1" class="tsd-kind-icon">Visibility</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 tsd-parent-kind-external-module">
<a name="any" class="tsd-anchor"></a>
<h3>Any</h3>
<div class="tsd-signature tsd-kind-icon">Any<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:4</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="arg" class="tsd-anchor"></a>
<h3>Arg</h3>
<div class="tsd-signature tsd-kind-icon">Arg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:5</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="asyncfunction" class="tsd-anchor"></a>
<h3>Async<wbr>Function</h3>
<div class="tsd-signature tsd-kind-icon">Async<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:65</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="baseinfo" class="tsd-anchor"></a>
<h3>Base<wbr>Info</h3>
<div class="tsd-signature tsd-kind-icon">Base<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:43</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>arg<wbr>Names<span class="tsd-signature-symbol">: </span><a href="_types_.html#name-2" class="tsd-signature-type">Name</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>name<span class="tsd-signature-symbol">: </span><a href="_types_.html#name-2" class="tsd-signature-type">Name</a></h5>
</li>
<li class="tsd-parameter">
<h5>owner<span class="tsd-signature-symbol">: </span><a href="_types_.html#name-2" class="tsd-signature-type">Name</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="callinfo" class="tsd-anchor"></a>
<h3>Call<wbr>Info</h3>
<div class="tsd-signature tsd-kind-icon">Call<wbr>Info<span class="tsd-signature-symbol">:</span> <a href="_types_.html#baseinfo" class="tsd-signature-type">BaseInfo</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:54</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="callrpc" class="tsd-anchor"></a>
<h3>CallRPC</h3>
<div class="tsd-signature tsd-kind-icon">CallRPC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:36</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="callbackfunction" class="tsd-anchor"></a>
<h3>Callback<wbr>Function</h3>
<div class="tsd-signature tsd-kind-icon">Callback<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:66</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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></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-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="closehandler" class="tsd-anchor"></a>
<h3>Close<wbr>Handler</h3>
<div class="tsd-signature tsd-kind-icon">Close<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:10</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>socket: <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="connectionhandler" class="tsd-anchor"></a>
<h3>Connection<wbr>Handler</h3>
<div class="tsd-signature tsd-kind-icon">Connection<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:8</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>socket: <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="errorhandler" class="tsd-anchor"></a>
<h3>Error<wbr>Handler</h3>
<div class="tsd-signature tsd-kind-icon">Error<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:9</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a>, error<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>socket: <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h5>
</li>
<li>
<h5>error: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a name="errorresponse" class="tsd-anchor"></a>
<h3>Error<wbr>Response</h3>
<div class="tsd-signature tsd-kind-icon">Error<wbr>Response&lt;T&gt;<span class="tsd-signature-symbol">:</span> <a href="_types_.html#respose" class="tsd-signature-type">Respose</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:24</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="extendedrpcinfo" class="tsd-anchor"></a>
<h3>Extended<wbr>Rpc<wbr>Info</h3>
<div class="tsd-signature tsd-kind-icon">Extended<wbr>Rpc<wbr>Info<span class="tsd-signature-symbol">:</span> <a href="_types_.html#rpcinfo" class="tsd-signature-type">RpcInfo</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:60</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a name="hookclosefunction" class="tsd-anchor"></a>
<h3>Hook<wbr>Close<wbr>Function</h3>
<div class="tsd-signature tsd-kind-icon">Hook<wbr>Close<wbr>Function&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:63</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="_types_.html#subscriptionresponse" class="tsd-signature-type">SubscriptionResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span>, rpc<span class="tsd-signature-symbol">: </span><a href="_types_.html#hookrpc" class="tsd-signature-type">HookRPC</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>res: <a href="_types_.html#subscriptionresponse" class="tsd-signature-type">SubscriptionResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>rpc: <a href="_types_.html#hookrpc" class="tsd-signature-type">HookRPC</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a name="hookfunction" class="tsd-anchor"></a>
<h3>Hook<wbr>Function</h3>
<div class="tsd-signature tsd-kind-icon">Hook<wbr>Function&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:64</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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">&lt;</span><a href="_types_.html#subscriptionresponse" class="tsd-signature-type">SubscriptionResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="_types_.html#errorresponse" class="tsd-signature-type">ErrorResponse</a><span class="tsd-signature-symbol">&gt;</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-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="_types_.html#subscriptionresponse" class="tsd-signature-type">SubscriptionResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="_types_.html#errorresponse" class="tsd-signature-type">ErrorResponse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a name="hookinfo" class="tsd-anchor"></a>
<h3>Hook<wbr>Info</h3>
<div class="tsd-signature tsd-kind-icon">Hook<wbr>Info&lt;T&gt;<span class="tsd-signature-symbol">:</span> <a href="_types_.html#baseinfo" class="tsd-signature-type">BaseInfo</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:49</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a name="hookrpc" class="tsd-anchor"></a>
<h3>HookRPC</h3>
<div class="tsd-signature tsd-kind-icon">HookRPC&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:29</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>hook<span class="tsd-signature-symbol">: </span><a href="_types_.html#hookfunction" class="tsd-signature-type">HookFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li class="tsd-parameter">
<h5>name<span class="tsd-signature-symbol">: </span><a href="_types_.html#name-2" class="tsd-signature-type">Name</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Callback<span class="tsd-signature-symbol">?: </span><a href="_types_.html#callbackfunction" class="tsd-signature-type">CallbackFunction</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Close<span class="tsd-signature-symbol">?: </span><a href="_types_.html#hookclosefunction" class="tsd-signature-type">HookCloseFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="name-2" class="tsd-anchor"></a>
<h3>Name</h3>
<div class="tsd-signature tsd-kind-icon">Name<span class="tsd-signature-symbol">:</span> <a href="_types_.html#arg" class="tsd-signature-type">Arg</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:6</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="onfunction" class="tsd-anchor"></a>
<h3>On<wbr>Function</h3>
<div class="tsd-signature tsd-kind-icon">On<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:62</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"close"</span>, f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"close"</span></h5>
</li>
<li>
<h5>f: <span class="tsd-signature-type">function</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<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></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> e: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="outcome" class="tsd-anchor"></a>
<h3>Outcome</h3>
<div class="tsd-signature tsd-kind-icon">Outcome<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Success"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Error"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:19</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="owner-1" class="tsd-anchor"></a>
<h3>Owner</h3>
<div class="tsd-signature tsd-kind-icon">Owner<span class="tsd-signature-symbol">:</span> <a href="_types_.html#name-2" class="tsd-signature-type">Name</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:7</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a name="rpc" class="tsd-anchor"></a>
<h3>RPC</h3>
<div class="tsd-signature tsd-kind-icon">RPC&lt;T&gt;<span class="tsd-signature-symbol">:</span> <a href="_types_.html#callrpc" class="tsd-signature-type">CallRPC</a><span class="tsd-signature-symbol"> | </span><a href="_types_.html#hookrpc" class="tsd-signature-type">HookRPC</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:41</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="rpctype" class="tsd-anchor"></a>
<h3>RPCType</h3>
<div class="tsd-signature tsd-kind-icon">RPCType<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Hook"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Unhook"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Call"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:27</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="responsetype" class="tsd-anchor"></a>
<h3>Response<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Response<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Subscribe"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Success"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Error"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:18</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a name="respose" class="tsd-anchor"></a>
<h3>Respose</h3>
<div class="tsd-signature tsd-kind-icon">Respose&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:22</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="rpcinfo" class="tsd-anchor"></a>
<h3>Rpc<wbr>Info</h3>
<div class="tsd-signature tsd-kind-icon">Rpc<wbr>Info<span class="tsd-signature-symbol">:</span> <a href="_types_.html#hookinfo" class="tsd-signature-type">HookInfo</a><span class="tsd-signature-symbol"> | </span><a href="_types_.html#callinfo" class="tsd-signature-type">CallInfo</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:59</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="socketconf" class="tsd-anchor"></a>
<h3>Socket<wbr>Conf</h3>
<div class="tsd-signature tsd-kind-icon">Socket<wbr>Conf<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> close<wbr>Handler<span class="tsd-signature-symbol">?: </span><a href="_types_.html#closehandler" class="tsd-signature-type">CloseHandler</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> connection<wbr>Handler<span class="tsd-signature-symbol">?: </span><a href="_types_.html#connectionhandler" class="tsd-signature-type">ConnectionHandler</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> error<wbr>Handler<span class="tsd-signature-symbol">?: </span><a href="_types_.html#errorhandler" class="tsd-signature-type">ErrorHandler</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> visibility<span class="tsd-signature-symbol">?: </span><a href="_types_.html#visibility-1" class="tsd-signature-type">Visibility</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a name="subscriptionresponse" class="tsd-anchor"></a>
<h3>Subscription<wbr>Response</h3>
<div class="tsd-signature tsd-kind-icon">Subscription<wbr>Response&lt;T&gt;<span class="tsd-signature-symbol">:</span> <a href="_types_.html#respose" class="tsd-signature-type">Respose</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:25</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a name="successresponse" class="tsd-anchor"></a>
<h3>Success<wbr>Response</h3>
<div class="tsd-signature tsd-kind-icon">Success<wbr>Response&lt;T&gt;<span class="tsd-signature-symbol">:</span> <a href="_types_.html#respose" class="tsd-signature-type">Respose</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.ts:23</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="visibility-1" class="tsd-anchor"></a>
<h3>Visibility</h3>
<div class="tsd-signature tsd-kind-icon">Visibility<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"127.0.0.1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"0.0.0.0"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Types.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 ">
<a href="../index.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="_backend_.html">"<wbr>Backend"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_frontend_.html">"<wbr>Frontend"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_interfaces_.html">"<wbr>Interfaces"</a>
</li>
<li class="current tsd-kind-external-module">
<a href="_types_.html">"<wbr>Types"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_utils_.html">"<wbr>Utils"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#any" class="tsd-kind-icon">Any</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#arg" class="tsd-kind-icon">Arg</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#asyncfunction" class="tsd-kind-icon">Async<wbr>Function</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#baseinfo" class="tsd-kind-icon">Base<wbr>Info</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#callinfo" class="tsd-kind-icon">Call<wbr>Info</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#callrpc" class="tsd-kind-icon">CallRPC</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#callbackfunction" class="tsd-kind-icon">Callback<wbr>Function</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#closehandler" class="tsd-kind-icon">Close<wbr>Handler</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#connectionhandler" class="tsd-kind-icon">Connection<wbr>Handler</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#errorhandler" class="tsd-kind-icon">Error<wbr>Handler</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_types_.html#errorresponse" class="tsd-kind-icon">Error<wbr>Response</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#extendedrpcinfo" class="tsd-kind-icon">Extended<wbr>Rpc<wbr>Info</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_types_.html#hookclosefunction" class="tsd-kind-icon">Hook<wbr>Close<wbr>Function</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_types_.html#hookfunction" class="tsd-kind-icon">Hook<wbr>Function</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_types_.html#hookinfo" class="tsd-kind-icon">Hook<wbr>Info</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_types_.html#hookrpc" class="tsd-kind-icon">HookRPC</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#name-2" class="tsd-kind-icon">Name</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#onfunction" class="tsd-kind-icon">On<wbr>Function</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#outcome" class="tsd-kind-icon">Outcome</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#owner-1" class="tsd-kind-icon">Owner</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_types_.html#rpc" class="tsd-kind-icon">RPC</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#rpctype" class="tsd-kind-icon">RPCType</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#responsetype" class="tsd-kind-icon">Response<wbr>Type</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_types_.html#respose" class="tsd-kind-icon">Respose</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#rpcinfo" class="tsd-kind-icon">Rpc<wbr>Info</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#socketconf" class="tsd-kind-icon">Socket<wbr>Conf</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_types_.html#subscriptionresponse" class="tsd-kind-icon">Subscription<wbr>Response</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_types_.html#successresponse" class="tsd-kind-icon">Success<wbr>Response</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_types_.html#visibility-1" class="tsd-kind-icon">Visibility</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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>
docs/modules/_types_.md
+387
View File
@@ -0,0 +1,387 @@
[rpclibrary](../README.md) › ["Types"](_types_.md)
# External module: "Types"
## Index
### Type aliases
* [Any](_types_.md#any)
* [Arg](_types_.md#arg)
* [AsyncFunction](_types_.md#asyncfunction)
* [BaseInfo](_types_.md#baseinfo)
* [CallInfo](_types_.md#callinfo)
* [CallRPC](_types_.md#callrpc)
* [CallbackFunction](_types_.md#callbackfunction)
* [CloseHandler](_types_.md#closehandler)
* [ConnectionHandler](_types_.md#connectionhandler)
* [ErrorHandler](_types_.md#errorhandler)
* [ErrorResponse](_types_.md#errorresponse)
* [ExtendedRpcInfo](_types_.md#extendedrpcinfo)
* [HookCloseFunction](_types_.md#hookclosefunction)
* [HookFunction](_types_.md#hookfunction)
* [HookInfo](_types_.md#hookinfo)
* [HookRPC](_types_.md#hookrpc)
* [Name](_types_.md#name)
* [OnFunction](_types_.md#onfunction)
* [Outcome](_types_.md#outcome)
* [Owner](_types_.md#owner)
* [RPC](_types_.md#rpc)
* [RPCType](_types_.md#rpctype)
* [ResponseType](_types_.md#responsetype)
* [Respose](_types_.md#respose)
* [RpcInfo](_types_.md#rpcinfo)
* [SocketConf](_types_.md#socketconf)
* [SubscriptionResponse](_types_.md#subscriptionresponse)
* [SuccessResponse](_types_.md#successresponse)
* [Visibility](_types_.md#visibility)
## Type aliases
### Any
Ƭ **Any**: *any*
Defined in Types.ts:4
___
### Arg
Ƭ **Arg**: *string*
Defined in Types.ts:5
___
### AsyncFunction
Ƭ **AsyncFunction**: *function*
Defined in Types.ts:65
#### Type declaration:
▸ (...`args`: any): *Promise‹any›*
**Parameters:**
Name | Type |
------ | ------ |
`...args` | any |
___
### BaseInfo
Ƭ **BaseInfo**: *object*
Defined in Types.ts:43
#### Type declaration:
* **argNames**: *[Name](_types_.md#name)[]*
* **name**: *[Name](_types_.md#name)*
* **owner**: *[Name](_types_.md#name)*
___
### CallInfo
Ƭ **CallInfo**: *[BaseInfo](_types_.md#baseinfo) & object*
Defined in Types.ts:54
___
### CallRPC
Ƭ **CallRPC**: *object | Function*
Defined in Types.ts:36
___
### CallbackFunction
Ƭ **CallbackFunction**: *function*
Defined in Types.ts:66
#### Type declaration:
▸ (...`args`: any): *void*
**Parameters:**
Name | Type |
------ | ------ |
`...args` | any |
___
### CloseHandler
Ƭ **CloseHandler**: *function*
Defined in Types.ts:10
#### Type declaration:
▸ (`socket`: [Socket](../interfaces/_interfaces_.socket.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`socket` | [Socket](../interfaces/_interfaces_.socket.md) |
___
### ConnectionHandler
Ƭ **ConnectionHandler**: *function*
Defined in Types.ts:8
#### Type declaration:
▸ (`socket`: [Socket](../interfaces/_interfaces_.socket.md)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`socket` | [Socket](../interfaces/_interfaces_.socket.md) |
___
### ErrorHandler
Ƭ **ErrorHandler**: *function*
Defined in Types.ts:9
#### Type declaration:
▸ (`socket`: [Socket](../interfaces/_interfaces_.socket.md), `error`: any): *void*
**Parameters:**
Name | Type |
------ | ------ |
`socket` | [Socket](../interfaces/_interfaces_.socket.md) |
`error` | any |
___
### ErrorResponse
Ƭ **ErrorResponse**: *[Respose](_types_.md#respose)‹T› & object*
Defined in Types.ts:24
___
### ExtendedRpcInfo
Ƭ **ExtendedRpcInfo**: *[RpcInfo](_types_.md#rpcinfo) & object*
Defined in Types.ts:60
___
### HookCloseFunction
Ƭ **HookCloseFunction**: *function*
Defined in Types.ts:63
#### Type declaration:
▸ (`res`: [SubscriptionResponse](_types_.md#subscriptionresponse)‹T›, `rpc`: [HookRPC](_types_.md#hookrpc)‹T›): *any*
**Parameters:**
Name | Type |
------ | ------ |
`res` | [SubscriptionResponse](_types_.md#subscriptionresponse)‹T› |
`rpc` | [HookRPC](_types_.md#hookrpc)‹T› |
___
### HookFunction
Ƭ **HookFunction**: *function*
Defined in Types.ts:64
#### Type declaration:
▸ (...`args`: any): *Promise‹[SubscriptionResponse](_types_.md#subscriptionresponse)‹T› | [ErrorResponse](_types_.md#errorresponse)›*
**Parameters:**
Name | Type |
------ | ------ |
`...args` | any |
___
### HookInfo
Ƭ **HookInfo**: *[BaseInfo](_types_.md#baseinfo) & object*
Defined in Types.ts:49
___
### HookRPC
Ƭ **HookRPC**: *object*
Defined in Types.ts:29
#### Type declaration:
* **hook**: *[HookFunction](_types_.md#hookfunction)‹T›*
* **name**: *[Name](_types_.md#name)*
* **onCallback**? : *[CallbackFunction](_types_.md#callbackfunction)*
* **onClose**? : *[HookCloseFunction](_types_.md#hookclosefunction)‹T›*
___
### Name
Ƭ **Name**: *[Arg](_types_.md#arg)*
Defined in Types.ts:6
___
### OnFunction
Ƭ **OnFunction**: *function*
Defined in Types.ts:62
#### Type declaration:
▸ (`type`: "error" | "close", `f`: function): *[Socket](../interfaces/_interfaces_.socket.md)*
**Parameters:**
▪ **type**: *"error" | "close"*
▪ **f**: *function*
▸ (`e?`: any): *void*
**Parameters:**
Name | Type |
------ | ------ |
`e?` | any |
___
### Outcome
Ƭ **Outcome**: *"Success" | "Error"*
Defined in Types.ts:19
___
### Owner
Ƭ **Owner**: *[Name](_types_.md#name)*
Defined in Types.ts:7
___
### RPC
Ƭ **RPC**: *[CallRPC](_types_.md#callrpc) | [HookRPC](_types_.md#hookrpc)‹T›*
Defined in Types.ts:41
___
### RPCType
Ƭ **RPCType**: *"Hook" | "Unhook" | "Call"*
Defined in Types.ts:27
___
### ResponseType
Ƭ **ResponseType**: *"Subscribe" | "Success" | "Error"*
Defined in Types.ts:18
___
### Respose
Ƭ **Respose**: *T & object*
Defined in Types.ts:22
___
### RpcInfo
Ƭ **RpcInfo**: *[HookInfo](_types_.md#hookinfo) | [CallInfo](_types_.md#callinfo)*
Defined in Types.ts:59
___
### SocketConf
Ƭ **SocketConf**: *object*
Defined in Types.ts:11
#### Type declaration:
* **closeHandler**? : *[CloseHandler](_types_.md#closehandler)*
* **connectionHandler**? : *[ConnectionHandler](_types_.md#connectionhandler)*
* **errorHandler**? : *[ErrorHandler](_types_.md#errorhandler)*
* **visibility**? : *[Visibility](_types_.md#visibility)*
___
### SubscriptionResponse
Ƭ **SubscriptionResponse**: *[Respose](_types_.md#respose)‹T› & object*
Defined in Types.ts:25
___
### SuccessResponse
Ƭ **SuccessResponse**: *[Respose](_types_.md#respose)‹T› & object*
Defined in Types.ts:23
___
### Visibility
Ƭ **Visibility**: *"127.0.0.1" | "0.0.0.0"*
Defined in Types.ts:3
docs/modules/_utils_.html
-356
View File
@@ -1,356 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>&quot;Utils&quot; | rpclibrary</title>
<meta name="description" content="">
<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.js" 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">rpclibrary</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-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">Globals</a>
</li>
<li>
<a href="_utils_.html">&quot;Utils&quot;</a>
</li>
</ul>
<h1>External module &quot;Utils&quot;</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>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_utils_.html#extractargs" class="tsd-kind-icon">extract<wbr>Args</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_utils_.html#hookgenerator" class="tsd-kind-icon">hook<wbr>Generator</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_utils_.html#makesubresponse" class="tsd-kind-icon">make<wbr>Sub<wbr>Response</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_utils_.html#rpchooker" class="tsd-kind-icon">rpc<wbr>Hooker</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_utils_.html#rpctorpcinfo" class="tsd-kind-icon">rpc<wbr>ToRpcinfo</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-external-module tsd-is-not-exported">
<a name="extractargs" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> extract<wbr>Args</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Args<span class="tsd-signature-symbol">(</span>f<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Arg</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 Utils.ts:91</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>f: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.Arg</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a name="hookgenerator" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> hook<wbr>Generator</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">hook<wbr>Generator<span class="tsd-signature-symbol">(</span>rpc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.HookRPC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in Utils.ts:70</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>rpc: <span class="tsd-signature-type">T.HookRPC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">function</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">I.Socket</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_types_.html#hookfunction" class="tsd-signature-type">HookFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</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> socket: <span class="tsd-signature-type">I.Socket</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_types_.html#hookfunction" class="tsd-signature-type">HookFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
<a name="makesubresponse" class="tsd-anchor"></a>
<h3>make<wbr>Sub<wbr>Response</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">make<wbr>Sub<wbr>Response<span class="tsd-signature-symbol">(</span>uuid<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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><a href="_types_.html#subscriptionresponse" class="tsd-signature-type">SubscriptionResponse</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in Utils.ts:96</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> uuid: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_types_.html#subscriptionresponse" class="tsd-signature-type">SubscriptionResponse</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
<a name="rpchooker" class="tsd-anchor"></a>
<h3>rpc<wbr>Hooker</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">rpc<wbr>Hooker&lt;SubResT&gt;<span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a>, exporter<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_.exporter.html" class="tsd-signature-type">Exporter</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SubResT</span><span class="tsd-signature-symbol">&gt;</span>, makeUnique<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">T.ExtendedRpcInfo</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 Utils.ts:48</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>SubResT</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>socket: <a href="../interfaces/_interfaces_.socket.html" class="tsd-signature-type">Socket</a></h5>
</li>
<li>
<h5>exporter: <a href="../interfaces/_interfaces_.exporter.html" class="tsd-signature-type">Exporter</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SubResT</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> makeUnique: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.ExtendedRpcInfo</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
<a name="rpctorpcinfo" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> rpc<wbr>ToRpcinfo</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">rpc<wbr>ToRpcinfo&lt;SubResT&gt;<span class="tsd-signature-symbol">(</span>rpc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.RPC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SubResT</span><span class="tsd-signature-symbol">&gt;</span>, owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.Owner</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T.RpcInfo</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in Utils.ts:8</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>SubResT</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>rpc: <span class="tsd-signature-type">T.RPC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SubResT</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>owner: <span class="tsd-signature-type">T.Owner</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T.RpcInfo</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="../index.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="_backend_.html">"<wbr>Backend"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_frontend_.html">"<wbr>Frontend"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_interfaces_.html">"<wbr>Interfaces"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="_types_.html">"<wbr>Types"</a>
</li>
<li class="current tsd-kind-external-module">
<a href="_utils_.html">"<wbr>Utils"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_utils_.html#extractargs" class="tsd-kind-icon">extract<wbr>Args</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_utils_.html#hookgenerator" class="tsd-kind-icon">hook<wbr>Generator</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_utils_.html#makesubresponse" class="tsd-kind-icon">make<wbr>Sub<wbr>Response</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_utils_.html#rpchooker" class="tsd-kind-icon">rpc<wbr>Hooker</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_utils_.html#rpctorpcinfo" class="tsd-kind-icon">rpc<wbr>ToRpcinfo</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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>
docs/modules/_utils_.md
+112
View File
@@ -0,0 +1,112 @@
[rpclibrary](../README.md) › ["Utils"](_utils_.md)
# External module: "Utils"
## Index
### Functions
* [extractArgs](_utils_.md#const-extractargs)
* [hookGenerator](_utils_.md#const-hookgenerator)
* [makeSubResponse](_utils_.md#makesubresponse)
* [rpcHooker](_utils_.md#rpchooker)
* [rpcToRpcinfo](_utils_.md#const-rpctorpcinfo)
## Functions
### `Const` extractArgs
▸ **extractArgs**(`f`: Function): *T.Arg[]*
Defined in Utils.ts:91
**Parameters:**
Name | Type |
------ | ------ |
`f` | Function |
**Returns:** *T.Arg[]*
___
### `Const` hookGenerator
▸ **hookGenerator**(`rpc`: T.HookRPC‹any›): *function*
Defined in Utils.ts:70
**Parameters:**
Name | Type |
------ | ------ |
`rpc` | T.HookRPC‹any› |
**Returns:** *function*
▸ (`socket?`: I.Socket): *[HookFunction](_types_.md#hookfunction)‹T›*
**Parameters:**
Name | Type |
------ | ------ |
`socket?` | I.Socket |
___
### makeSubResponse
▸ **makeSubResponse**(`uuid?`: undefined | string): *[SubscriptionResponse](_types_.md#subscriptionresponse)*
Defined in Utils.ts:96
**Parameters:**
Name | Type |
------ | ------ |
`uuid?` | undefined &#124; string |
**Returns:** *[SubscriptionResponse](_types_.md#subscriptionresponse)*
___
### rpcHooker
▸ **rpcHooker**<**SubResT**>(`socket`: [Socket](../interfaces/_interfaces_.socket.md), `exporter`: [Exporter](../interfaces/_interfaces_.exporter.md)‹SubResT›, `makeUnique`: boolean): *T.ExtendedRpcInfo[]*
Defined in Utils.ts:48
**Type parameters:**
▪ **SubResT**
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`socket` | [Socket](../interfaces/_interfaces_.socket.md) | - |
`exporter` | [Exporter](../interfaces/_interfaces_.exporter.md)‹SubResT› | - |
`makeUnique` | boolean | true |
**Returns:** *T.ExtendedRpcInfo[]*
___
### `Const` rpcToRpcinfo
▸ **rpcToRpcinfo**<**SubResT**>(`rpc`: T.RPC‹SubResT›, `owner`: T.Owner): *T.RpcInfo*
Defined in Utils.ts:8
**Type parameters:**
▪ **SubResT**
**Parameters:**
Name | Type |
------ | ------ |
`rpc` | T.RPC‹SubResT› |
`owner` | T.Owner |
**Returns:** *T.RpcInfo*