Skip to content

Commit c1a1419

Browse files
committed
docs: generating docs
1 parent 12fb115 commit c1a1419

File tree

76 files changed

+329
-334
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+329
-334
lines changed

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/RPCClient.html

Lines changed: 25 additions & 52 deletions
Large diffs are not rendered by default.

docs/classes/RPCServer.html

Lines changed: 41 additions & 63 deletions
Large diffs are not rendered by default.

docs/classes/errors.ErrorHandlerAborted.html

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h4>Hierarchy</h4>
2828
<ul class="tsd-hierarchy">
2929
<li><span class="target">ErrorHandlerAborted</span></li></ul></li></ul></section><aside class="tsd-sources">
3030
<ul>
31-
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L111">src/errors.ts:111</a></li></ul></aside>
31+
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L115">src/errors.ts:115</a></li></ul></aside>
3232
<section class="tsd-panel-group tsd-index-group">
3333
<section class="tsd-panel tsd-index-panel">
3434
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -109,7 +109,7 @@ <h3 class="tsd-anchor-link"><span>code</span><a href="#code" aria-label="Permali
109109
<div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <a href="../enums/errors.JSONRPCResponseErrorCode.html" class="tsd-signature-type tsd-kind-enum">JSONRPCResponseErrorCode</a><span class="tsd-signature-symbol"> = JSONRPCResponseErrorCode.HandlerAborted</span></div><aside class="tsd-sources">
110110
<p>Overrides <a href="errors.ErrorRPCProtocol.html">ErrorRPCProtocol</a>.<a href="errors.ErrorRPCProtocol.html#code">code</a></p>
111111
<ul>
112-
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L113">src/errors.ts:113</a></li></ul></aside></section>
112+
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L117">src/errors.ts:117</a></li></ul></aside></section>
113113
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="data" class="tsd-anchor"></a>
114114
<h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
115115
<div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">POJO</span></div>
@@ -152,13 +152,13 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
152152
<div class="tsd-signature"><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Handler Aborted Stream&#39;</span></div><aside class="tsd-sources">
153153
<p>Overrides <a href="errors.ErrorRPCProtocol.html">ErrorRPCProtocol</a>.<a href="errors.ErrorRPCProtocol.html#description">description</a></p>
154154
<ul>
155-
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L112">src/errors.ts:112</a></li></ul></aside></section>
155+
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L116">src/errors.ts:116</a></li></ul></aside></section>
156156
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="error" class="tsd-anchor"></a>
157157
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
158158
<div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;RPC Protocol Error&#39;</span></div><aside class="tsd-sources">
159159
<p>Inherited from <a href="errors.ErrorRPCProtocol.html">ErrorRPCProtocol</a>.<a href="errors.ErrorRPCProtocol.html#error">error</a></p>
160160
<ul>
161-
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L39">src/errors.ts:39</a></li></ul></aside></section>
161+
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L43">src/errors.ts:43</a></li></ul></aside></section>
162162
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
163163
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
164164
<div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>
@@ -215,7 +215,7 @@ <h4 class="tsd-returns-title">Returns <a href="../types/JSONRPCResponseError.htm
215215
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
216216
<p>Inherited from <a href="errors.ErrorRPCProtocol.html">ErrorRPCProtocol</a>.<a href="errors.ErrorRPCProtocol.html#toJSON">toJSON</a></p>
217217
<ul>
218-
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L74">src/errors.ts:74</a></li></ul></aside></li></ul></section>
218+
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L78">src/errors.ts:78</a></li></ul></aside></li></ul></section>
219219
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
220220
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
221221
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
@@ -260,7 +260,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Instance
260260
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
261261
<p>Inherited from <a href="errors.ErrorRPCProtocol.html">ErrorRPCProtocol</a>.<a href="errors.ErrorRPCProtocol.html#fromJSON">fromJSON</a></p>
262262
<ul>
263-
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L42">src/errors.ts:42</a></li></ul></aside></li></ul></section></section></div>
263+
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L46">src/errors.ts:46</a></li></ul></aside></li></ul></section></section></div>
264264
<div class="col-sidebar">
265265
<div class="page-menu">
266266
<div class="tsd-navigation settings">
@@ -329,6 +329,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
329329
<li><a href="errors.ErrorRPCStopping.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorRPCStopping</span></a></li>
330330
<li><a href="errors.ErrorRPCStreamEnded.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorRPCStream<wbr/>Ended</span></a></li>
331331
<li><a href="errors.ErrorRPCTimedOut.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorRPCTimed<wbr/>Out</span></a></li>
332+
<li><a href="errors.ErrorRPCUndefinedBehaviour.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorRPCUndefined<wbr/>Behaviour</span></a></li>
332333
<li><a href="errors.ErrorRPCUnknown.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorRPCUnknown</span></a></li>
333334
<li><a href="errors.ErrorUtilsUndefinedBehaviour.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>Utils<wbr/>Undefined<wbr/>Behaviour</span></a></li>
334335
<li><a href="../variables/errors.rpcProtocolErrors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>rpc<wbr/>Protocol<wbr/>Errors</span></a></li></ul></div></details></li>

docs/classes/errors.ErrorMissingCaller.html

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h4>Hierarchy</h4>
2828
<ul class="tsd-hierarchy">
2929
<li><span class="target">ErrorMissingCaller</span></li></ul></li></ul></section><aside class="tsd-sources">
3030
<ul>
31-
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L102">src/errors.ts:102</a></li></ul></aside>
31+
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L106">src/errors.ts:106</a></li></ul></aside>
3232
<section class="tsd-panel-group tsd-index-group">
3333
<section class="tsd-panel tsd-index-panel">
3434
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -109,7 +109,7 @@ <h3 class="tsd-anchor-link"><span>code</span><a href="#code" aria-label="Permali
109109
<div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <a href="../enums/errors.JSONRPCResponseErrorCode.html" class="tsd-signature-type tsd-kind-enum">JSONRPCResponseErrorCode</a><span class="tsd-signature-symbol"> = JSONRPCResponseErrorCode.MissingCaller</span></div><aside class="tsd-sources">
110110
<p>Overrides <a href="errors.ErrorRPCProtocol.html">ErrorRPCProtocol</a>.<a href="errors.ErrorRPCProtocol.html#code">code</a></p>
111111
<ul>
112-
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L104">src/errors.ts:104</a></li></ul></aside></section>
112+
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L108">src/errors.ts:108</a></li></ul></aside></section>
113113
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="data" class="tsd-anchor"></a>
114114
<h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
115115
<div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">POJO</span></div>
@@ -152,13 +152,13 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
152152
<div class="tsd-signature"><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Caller is missing&#39;</span></div><aside class="tsd-sources">
153153
<p>Overrides <a href="errors.ErrorRPCProtocol.html">ErrorRPCProtocol</a>.<a href="errors.ErrorRPCProtocol.html#description">description</a></p>
154154
<ul>
155-
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L103">src/errors.ts:103</a></li></ul></aside></section>
155+
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L107">src/errors.ts:107</a></li></ul></aside></section>
156156
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="error" class="tsd-anchor"></a>
157157
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
158158
<div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;RPC Protocol Error&#39;</span></div><aside class="tsd-sources">
159159
<p>Inherited from <a href="errors.ErrorRPCProtocol.html">ErrorRPCProtocol</a>.<a href="errors.ErrorRPCProtocol.html#error">error</a></p>
160160
<ul>
161-
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L39">src/errors.ts:39</a></li></ul></aside></section>
161+
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L43">src/errors.ts:43</a></li></ul></aside></section>
162162
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
163163
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
164164
<div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>
@@ -215,7 +215,7 @@ <h4 class="tsd-returns-title">Returns <a href="../types/JSONRPCResponseError.htm
215215
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
216216
<p>Inherited from <a href="errors.ErrorRPCProtocol.html">ErrorRPCProtocol</a>.<a href="errors.ErrorRPCProtocol.html#toJSON">toJSON</a></p>
217217
<ul>
218-
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L74">src/errors.ts:74</a></li></ul></aside></li></ul></section>
218+
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L78">src/errors.ts:78</a></li></ul></aside></li></ul></section>
219219
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
220220
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
221221
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
@@ -260,7 +260,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Instance
260260
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
261261
<p>Inherited from <a href="errors.ErrorRPCProtocol.html">ErrorRPCProtocol</a>.<a href="errors.ErrorRPCProtocol.html#fromJSON">fromJSON</a></p>
262262
<ul>
263-
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L42">src/errors.ts:42</a></li></ul></aside></li></ul></section></section></div>
263+
<li>Defined in <a href="https://github.com/MatrixAI/js-rpc/blob/master/src/errors.ts#L46">src/errors.ts:46</a></li></ul></aside></li></ul></section></section></div>
264264
<div class="col-sidebar">
265265
<div class="page-menu">
266266
<div class="tsd-navigation settings">
@@ -329,6 +329,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
329329
<li><a href="errors.ErrorRPCStopping.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorRPCStopping</span></a></li>
330330
<li><a href="errors.ErrorRPCStreamEnded.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorRPCStream<wbr/>Ended</span></a></li>
331331
<li><a href="errors.ErrorRPCTimedOut.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorRPCTimed<wbr/>Out</span></a></li>
332+
<li><a href="errors.ErrorRPCUndefinedBehaviour.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorRPCUndefined<wbr/>Behaviour</span></a></li>
332333
<li><a href="errors.ErrorRPCUnknown.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorRPCUnknown</span></a></li>
333334
<li><a href="errors.ErrorUtilsUndefinedBehaviour.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>Utils<wbr/>Undefined<wbr/>Behaviour</span></a></li>
334335
<li><a href="../variables/errors.rpcProtocolErrors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>rpc<wbr/>Protocol<wbr/>Errors</span></a></li></ul></div></details></li>

0 commit comments

Comments
 (0)