Skip to content

Commit ee3df3e

Browse files
Update documentation
1 parent 2ee551e commit ee3df3e

File tree

151 files changed

+1402
-1020
lines changed

Some content is hidden

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

151 files changed

+1402
-1020
lines changed

docs/assets/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/Agent.html

+11-10
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ <h4>Hierarchy</h4>
2525
<ul class="tsd-hierarchy">
2626
<li><span class="target">Agent</span></li></ul></section><aside class="tsd-sources">
2727
<ul>
28-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L20">keri/app/controller.ts:20</a></li></ul></aside>
28+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L20">keri/app/controller.ts:20</a></li></ul></aside>
2929
<section class="tsd-panel-group tsd-index-group">
3030
<section class="tsd-panel tsd-index-panel">
3131
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -63,39 +63,39 @@ <h4 class="tsd-parameters-title">Parameters</h4>
6363
<h5><span class="tsd-kind-parameter">agent</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
6464
<h4 class="tsd-returns-title">Returns <a href="Agent.html" class="tsd-signature-type tsd-kind-class">Agent</a></h4><aside class="tsd-sources">
6565
<ul>
66-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L28">keri/app/controller.ts:28</a></li></ul></aside></li></ul></section></section>
66+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L28">keri/app/controller.ts:28</a></li></ul></aside></li></ul></section></section>
6767
<section class="tsd-panel-group tsd-member-group">
6868
<h2>Properties</h2>
6969
<section class="tsd-panel tsd-member"><a id="anchor" class="tsd-anchor"></a>
7070
<h3 class="tsd-anchor-link"><span>anchor</span><a href="#anchor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7171
<div class="tsd-signature"><span class="tsd-kind-property">anchor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
7272
<ul>
73-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L22">keri/app/controller.ts:22</a></li></ul></aside></section>
73+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L22">keri/app/controller.ts:22</a></li></ul></aside></section>
7474
<section class="tsd-panel tsd-member"><a id="pre" class="tsd-anchor"></a>
7575
<h3 class="tsd-anchor-link"><span>pre</span><a href="#pre" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7676
<div class="tsd-signature"><span class="tsd-kind-property">pre</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
7777
<ul>
78-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L21">keri/app/controller.ts:21</a></li></ul></aside></section>
78+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L21">keri/app/controller.ts:21</a></li></ul></aside></section>
7979
<section class="tsd-panel tsd-member"><a id="said" class="tsd-anchor"></a>
8080
<h3 class="tsd-anchor-link"><span>said</span><a href="#said" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
8181
<div class="tsd-signature"><span class="tsd-kind-property">said</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
8282
<ul>
83-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L26">keri/app/controller.ts:26</a></li></ul></aside></section>
83+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L26">keri/app/controller.ts:26</a></li></ul></aside></section>
8484
<section class="tsd-panel tsd-member"><a id="sn" class="tsd-anchor"></a>
8585
<h3 class="tsd-anchor-link"><span>sn</span><a href="#sn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
8686
<div class="tsd-signature"><span class="tsd-kind-property">sn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
8787
<ul>
88-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L25">keri/app/controller.ts:25</a></li></ul></aside></section>
88+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L25">keri/app/controller.ts:25</a></li></ul></aside></section>
8989
<section class="tsd-panel tsd-member"><a id="state" class="tsd-anchor"></a>
9090
<h3 class="tsd-anchor-link"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
9191
<div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources">
9292
<ul>
93-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L24">keri/app/controller.ts:24</a></li></ul></aside></section>
93+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L24">keri/app/controller.ts:24</a></li></ul></aside></section>
9494
<section class="tsd-panel tsd-member"><a id="verfer" class="tsd-anchor"></a>
9595
<h3 class="tsd-anchor-link"><span>verfer</span><a href="#verfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
9696
<div class="tsd-signature"><span class="tsd-kind-property">verfer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Verfer.html" class="tsd-signature-type tsd-kind-class">Verfer</a></div><aside class="tsd-sources">
9797
<ul>
98-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L23">keri/app/controller.ts:23</a></li></ul></aside></section></section>
98+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L23">keri/app/controller.ts:23</a></li></ul></aside></section></section>
9999
<section class="tsd-panel-group tsd-member-group">
100100
<h2>Methods</h2>
101101
<section class="tsd-panel tsd-member tsd-is-private"><a id="event" class="tsd-anchor"></a>
@@ -110,7 +110,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
110110
<h5><span class="tsd-kind-parameter">evt</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
111111
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="Verfer.html" class="tsd-signature-type tsd-kind-class">Verfer</a><span class="tsd-signature-symbol">, </span><a href="Diger.html" class="tsd-signature-type tsd-kind-class">Diger</a><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources">
112112
<ul>
113-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L60">keri/app/controller.ts:60</a></li></ul></aside></li></ul></section>
113+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L60">keri/app/controller.ts:60</a></li></ul></aside></li></ul></section>
114114
<section class="tsd-panel tsd-member tsd-is-private"><a id="parse" class="tsd-anchor"></a>
115115
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>parse</span><a href="#parse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
116116
<ul class="tsd-signatures tsd-is-private">
@@ -123,7 +123,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
123123
<h5><span class="tsd-kind-parameter">agent</span>: <a href="Agent.html" class="tsd-signature-type tsd-kind-class">Agent</a></h5></li></ul></div>
124124
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
125125
<ul>
126-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/app/controller.ts#L38">keri/app/controller.ts:38</a></li></ul></aside></li></ul></section></section></div>
126+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/app/controller.ts#L38">keri/app/controller.ts:38</a></li></ul></aside></li></ul></section></section></div>
127127
<div class="col-sidebar">
128128
<div class="page-menu">
129129
<div class="tsd-navigation settings">
@@ -290,6 +290,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
290290
<li><a href="../functions/nowUTC.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>nowUTC</span></a></li>
291291
<li><a href="../functions/openManager.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>open<wbr/>Manager</span></a></li>
292292
<li><a href="../functions/pad.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>pad</span></a></li>
293+
<li><a href="../functions/parseRangeHeaders.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>parse<wbr/>Range<wbr/>Headers</span></a></li>
293294
<li><a href="../functions/randomNonce.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>random<wbr/>Nonce</span></a></li>
294295
<li><a href="../functions/randomPasscode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>random<wbr/>Passcode</span></a></li>
295296
<li><a href="../functions/range.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>range</span></a></li>

docs/classes/Authenticater.html

+8-7
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
2020
<ul class="tsd-hierarchy">
2121
<li><span class="target">Authenticater</span></li></ul></section><aside class="tsd-sources">
2222
<ul>
23-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L7">keri/core/authing.ts:7</a></li></ul></aside>
23+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L7">keri/core/authing.ts:7</a></li></ul></aside>
2424
<section class="tsd-panel-group tsd-index-group">
2525
<section class="tsd-panel tsd-index-panel">
2626
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -57,24 +57,24 @@ <h5><span class="tsd-kind-parameter">csig</span>: <a href="Signer.html" class="t
5757
<h5><span class="tsd-kind-parameter">verfer</span>: <a href="Verfer.html" class="tsd-signature-type tsd-kind-class">Verfer</a></h5></li></ul></div>
5858
<h4 class="tsd-returns-title">Returns <a href="Authenticater.html" class="tsd-signature-type tsd-kind-class">Authenticater</a></h4><aside class="tsd-sources">
5959
<ul>
60-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L18">keri/core/authing.ts:18</a></li></ul></aside></li></ul></section></section>
60+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L18">keri/core/authing.ts:18</a></li></ul></aside></li></ul></section></section>
6161
<section class="tsd-panel-group tsd-member-group">
6262
<h2>Properties</h2>
6363
<section class="tsd-panel tsd-member tsd-is-private"><a id="_csig" class="tsd-anchor"></a>
6464
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>_csig</span><a href="#_csig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
6565
<div class="tsd-signature"><span class="tsd-kind-property">_csig</span><span class="tsd-signature-symbol">:</span> <a href="Signer.html" class="tsd-signature-type tsd-kind-class">Signer</a></div><aside class="tsd-sources">
6666
<ul>
67-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L16">keri/core/authing.ts:16</a></li></ul></aside></section>
67+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L16">keri/core/authing.ts:16</a></li></ul></aside></section>
6868
<section class="tsd-panel tsd-member tsd-is-private"><a id="_verfer" class="tsd-anchor"></a>
6969
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_verfer</span><a href="#_verfer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7070
<div class="tsd-signature"><span class="tsd-kind-property">_verfer</span><span class="tsd-signature-symbol">:</span> <a href="Verfer.html" class="tsd-signature-type tsd-kind-class">Verfer</a></div><aside class="tsd-sources">
7171
<ul>
72-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L15">keri/core/authing.ts:15</a></li></ul></aside></section>
72+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L15">keri/core/authing.ts:15</a></li></ul></aside></section>
7373
<section class="tsd-panel tsd-member"><a id="DefaultFields" class="tsd-anchor"></a>
7474
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>Default<wbr/>Fields</span><a href="#DefaultFields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7575
<div class="tsd-signature"><span class="tsd-kind-property">Default<wbr/>Fields</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></div><aside class="tsd-sources">
7676
<ul>
77-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L9">keri/core/authing.ts:9</a></li></ul></aside></section></section>
77+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L9">keri/core/authing.ts:9</a></li></ul></aside></section></section>
7878
<section class="tsd-panel-group tsd-member-group">
7979
<h2>Methods</h2>
8080
<section class="tsd-panel tsd-member"><a id="sign" class="tsd-anchor"></a>
@@ -95,7 +95,7 @@ <h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-typ
9595
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">fields</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
9696
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Headers</span></h4><aside class="tsd-sources">
9797
<ul>
98-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L84">keri/core/authing.ts:84</a></li></ul></aside></li></ul></section>
98+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L84">keri/core/authing.ts:84</a></li></ul></aside></li></ul></section>
9999
<section class="tsd-panel tsd-member"><a id="verify" class="tsd-anchor"></a>
100100
<h3 class="tsd-anchor-link"><span>verify</span><a href="#verify" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
101101
<ul class="tsd-signatures">
@@ -112,7 +112,7 @@ <h5><span class="tsd-kind-parameter">method</span>: <span class="tsd-signature-t
112112
<h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
113113
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
114114
<ul>
115-
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/119d3df/src/keri/core/authing.ts#L23">keri/core/authing.ts:23</a></li></ul></aside></li></ul></section></section></div>
115+
<li>Defined in <a href="https://github.com/WebOfTrust/signify-ts/blob/2ee551e/src/keri/core/authing.ts#L23">keri/core/authing.ts:23</a></li></ul></aside></li></ul></section></section></div>
116116
<div class="col-sidebar">
117117
<div class="page-menu">
118118
<div class="tsd-navigation settings">
@@ -276,6 +276,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
276276
<li><a href="../functions/nowUTC.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>nowUTC</span></a></li>
277277
<li><a href="../functions/openManager.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>open<wbr/>Manager</span></a></li>
278278
<li><a href="../functions/pad.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>pad</span></a></li>
279+
<li><a href="../functions/parseRangeHeaders.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>parse<wbr/>Range<wbr/>Headers</span></a></li>
279280
<li><a href="../functions/randomNonce.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>random<wbr/>Nonce</span></a></li>
280281
<li><a href="../functions/randomPasscode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>random<wbr/>Passcode</span></a></li>
281282
<li><a href="../functions/range.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>range</span></a></li>

0 commit comments

Comments
 (0)