Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feat/update docs #89

Merged
merged 2 commits into from
Aug 22, 2023
Merged

Feat/update docs #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34970a2
doc generation
m00sey Aug 22, 2023
3ab0113
doc generation
m00sey Aug 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/assets/search.js
View file
Open in desktop

Large diffs are not rendered by default.

33 changes: 22 additions & 11 deletions docs/classes/Agent.html
View file
Open in desktop

Large diffs are not rendered by default.

27 changes: 19 additions & 8 deletions docs/classes/Authenticater.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Authenticater</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/6de32b6/src/keri/core/authing.ts#L7">keri/core/authing.ts:7</a></li></ul></aside>
<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>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -57,24 +57,24 @@ <h5><span class="tsd-kind-parameter">csig</span>: <a href="Signer.html" class="t
<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>
<h4 class="tsd-returns-title">Returns <a href="Authenticater.html" class="tsd-signature-type tsd-kind-class">Authenticater</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/6de32b6/src/keri/core/authing.ts#L18">keri/core/authing.ts:18</a></li></ul></aside></li></ul></section></section>
<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>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_csig" class="tsd-anchor"></a>
<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>
<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">
<ul>
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/6de32b6/src/keri/core/authing.ts#L16">keri/core/authing.ts:16</a></li></ul></aside></section>
<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>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_verfer" class="tsd-anchor"></a>
<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>
<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">
<ul>
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/6de32b6/src/keri/core/authing.ts#L15">keri/core/authing.ts:15</a></li></ul></aside></section>
<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>
<section class="tsd-panel tsd-member"><a id="DefaultFields" class="tsd-anchor"></a>
<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>
<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">
<ul>
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/6de32b6/src/keri/core/authing.ts#L9">keri/core/authing.ts:9</a></li></ul></aside></section></section>
<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>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="sign" class="tsd-anchor"></a>
Expand All @@ -95,7 +95,7 @@ <h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-typ
<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>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Headers</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/6de32b6/src/keri/core/authing.ts#L84">keri/core/authing.ts:84</a></li></ul></aside></li></ul></section>
<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>
<section class="tsd-panel tsd-member"><a id="verify" class="tsd-anchor"></a>
<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>
<ul class="tsd-signatures">
Expand All @@ -112,7 +112,7 @@ <h5><span class="tsd-kind-parameter">method</span>: <span class="tsd-signature-t
<h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/m00sey/signify-ts/blob/6de32b6/src/keri/core/authing.ts#L23">keri/core/authing.ts:23</a></li></ul></aside></li></ul></section></section></div>
<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>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down Expand Up @@ -150,42 +150,53 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="Authenticater.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Authenticater</span></a></li>
<li><a href="BexCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Bex<wbr/>Codex</span></a></li>
<li><a href="CesrNumber.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cesr<wbr/>Number</span></a></li>
<li><a href="Challenges.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Challenges</span></a></li>
<li><a href="Cigar.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cigar</span></a></li>
<li><a href="Cipher.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cipher</span></a></li>
<li><a href="Client.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Client</span></a></li>
<li><a href="Codex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Codex</span></a></li>
<li><a href="Contacts.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Contacts</span></a></li>
<li><a href="Controller.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Controller</span></a></li>
<li><a href="Counter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Counter</span></a></li>
<li><a href="CounterCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Counter<wbr/>Codex</span></a></li>
<li><a href="Creatory.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Creatory</span></a></li>
<li><a href="CredentialTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Credential<wbr/>Types</span></a></li>
<li><a href="Credentials.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Credentials</span></a></li>
<li><a href="Decrypter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Decrypter</span></a></li>
<li><a href="Diger.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Diger</span></a></li>
<li><a href="DigiCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Digi<wbr/>Codex</span></a></li>
<li><a href="EmptyMaterialError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Empty<wbr/>Material<wbr/>Error</span></a></li>
<li><a href="Encrypter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Encrypter</span></a></li>
<li><a href="Escrows.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Escrows</span></a></li>
<li><a href="GroupKeeper.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Group<wbr/>Keeper</span></a></li>
<li><a href="Hab.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Hab</span></a></li>
<li><a href="Habery.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Habery</span></a></li>
<li><a href="Identifier.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Identifier</span></a></li>
<li><a href="IndexedBothSigCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Indexed<wbr/>Both<wbr/>Sig<wbr/>Codex</span></a></li>
<li><a href="IndexedCurrentSigCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Indexed<wbr/>Current<wbr/>Sig<wbr/>Codex</span></a></li>
<li><a href="IndexedSigCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Indexed<wbr/>Sig<wbr/>Codex</span></a></li>
<li><a href="Indexer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Indexer</span></a></li>
<li><a href="IndexerCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Indexer<wbr/>Codex</span></a></li>
<li><a href="Inputage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Inputage</span></a></li>
<li><a href="KeyEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Key<wbr/>Events</span></a></li>
<li><a href="KeyManager.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Key<wbr/>Manager</span></a></li>
<li><a href="KeyStates.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Key<wbr/>States</span></a></li>
<li><a href="Manager.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Manager</span></a></li>
<li><a href="Matter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Matter</span></a></li>
<li><a href="MatterCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Matter<wbr/>Codex</span></a></li>
<li><a href="NonTransCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Non<wbr/>Trans<wbr/>Codex</span></a></li>
<li><a href="Notifications.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Notifications</span></a></li>
<li><a href="NumCodex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Num<wbr/>Codex</span></a></li>
<li><a href="Oobis.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Oobis</span></a></li>
<li><a href="Operations.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Operations</span></a></li>
<li><a href="Prefixer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Prefixer</span></a></li>
<li><a href="RandyCreator.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Randy<wbr/>Creator</span></a></li>
<li><a href="RandyKeeper.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Randy<wbr/>Keeper</span></a></li>
<li><a href="Registries.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Registries</span></a></li>
<li><a href="Saider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Saider</span></a></li>
<li><a href="Salter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Salter</span></a></li>
<li><a href="SaltyCreator.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Salty<wbr/>Creator</span></a></li>
<li><a href="SaltyKeeper.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Salty<wbr/>Keeper</span></a></li>
<li><a href="Schemas.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Schemas</span></a></li>
<li><a href="Seqner.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Seqner</span></a></li>
<li><a href="Serder.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Serder</span></a></li>
<li><a href="Siger.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Siger</span></a></li>
Expand Down
Loading
Loading