Skip to content
This repository has been archived by the owner on May 29, 2024. It is now read-only.

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 3, 2023
1 parent be2d1d3 commit 38d9717
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
18 changes: 9 additions & 9 deletions docs/classes/QVI.html
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">QVI</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L13">qvi/qvi.ts:13</a></li></ul></aside>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L13">qvi/qvi.ts:13</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 @@ -74,24 +74,24 @@ <h5><span class="tsd-kind-parameter">registry</span>: <span class="tsd-signature
<h4 class="tsd-returns-title">Returns <a href="QVI.html" class="tsd-signature-type tsd-kind-class">QVI</a></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L32">qvi/qvi.ts:32</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L32">qvi/qvi.ts:32</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="client" 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>client</span><a href="#client" 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">client</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">SignifyClient</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L14">qvi/qvi.ts:14</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L14">qvi/qvi.ts:14</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="name" 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>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L15">qvi/qvi.ts:15</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L15">qvi/qvi.ts:15</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="registry" 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>registry</span><a href="#registry" 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">registry</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L16">qvi/qvi.ts:16</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L16">qvi/qvi.ts:16</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="createEngagementContextRoleCredential" class="tsd-anchor"></a>
Expand All @@ -116,7 +116,7 @@ <h5><span class="tsd-kind-parameter">edge</span>: <span class="tsd-signature-typ
<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>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L75">qvi/qvi.ts:75</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L75">qvi/qvi.ts:75</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="createLegalEntityCredential" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>create<wbr/>Legal<wbr/>Entity<wbr/>Credential</span><a href="#createLegalEntityCredential" 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 @@ -140,7 +140,7 @@ <h5><span class="tsd-kind-parameter">edge</span>: <span class="tsd-signature-typ
<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>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L48">qvi/qvi.ts:48</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L48">qvi/qvi.ts:48</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="createOfficialOrganizationRoleCredential" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>create<wbr/>Official<wbr/>Organization<wbr/>Role<wbr/>Credential</span><a href="#createOfficialOrganizationRoleCredential" 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 @@ -163,7 +163,7 @@ <h5><span class="tsd-kind-parameter">edge</span>: <span class="tsd-signature-typ
<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>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L102">qvi/qvi.ts:102</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L102">qvi/qvi.ts:102</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="sendLegalEntityCredential" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>send<wbr/>Legal<wbr/>Entity<wbr/>Credential</span><a href="#sendLegalEntityCredential" 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 @@ -182,7 +182,7 @@ <h5><span class="tsd-kind-parameter">getFromAgent</span>: <span class="tsd-signa
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">credential</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
<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><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L121">qvi/qvi.ts:121</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L121">qvi/qvi.ts:121</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/QVIvLEIEdge.html
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">QVIvLEIEdge</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L175">qvi/qvi.ts:175</a></li></ul></aside>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L175">qvi/qvi.ts:175</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 @@ -49,19 +49,19 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">qviAID</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="QVIvLEIEdge.html" class="tsd-signature-type tsd-kind-class">QVIvLEIEdge</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L179">qvi/qvi.ts:179</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L179">qvi/qvi.ts:179</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"><a id="n" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>n</span><a href="#n" 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">n</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L176">qvi/qvi.ts:176</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L176">qvi/qvi.ts:176</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="s" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>s</span><a href="#s" 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">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/qvi/qvi.ts#L177">qvi/qvi.ts:177</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/qvi/qvi.ts#L177">qvi/qvi.ts:177</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<div class="tsd-page-title">
<h2>qvi-ts</h2></div>
<div class="tsd-panel tsd-typography"><p><a href="https://github.com/GLEIF-IT/qvi-ts/actions/workflows/main.yml"><img src="https://github.com/GLEIF-IT/qvi-ts/actions/workflows/main.yml/badge.svg?branch=main" alt="CI"></a>
<a href="https://codecov.io/gh/GLEIF-IT/qvi-ts"><img src="https://codecov.io/gh/GLEIF-IT/qvi-ts/graph/badge.svg?token=DKG7H94FLS" alt="codecov"></a>
<a href="https://codecov.io/gh/GLEIF-IT/qvi-ts"><img src="https://codecov.io/gh/GLEIF-IT/qvi-ts/graph/badge.svg?token=62IU4HHXE1" alt="codecov"></a>
<a href="https://gleif-it.github.io/qvi-ts/"><img src="https://img.shields.io/badge/documentation-grey?" alt="Documentation"></a></p>
<a id="md:qvi-ts" class="tsd-anchor"></a><h1><a href="#md:qvi-ts">qvi-ts</a></h1><p>QVI SDK for the vLEI Ecosystem</p>
<a id="md:development" class="tsd-anchor"></a><h3><a href="#md:development">Development</a></h3><p>Install dependencies</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/types/AID.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<h1>Type alias AID</h1></div>
<div class="tsd-signature"><span class="tsd-kind-type-alias">AID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/f2d0aa2/src/index.ts#L1">index.ts:1</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/GLEIF-IT/qvi-ts/blob/be2d1d3/src/index.ts#L1">index.ts:1</a></li></ul></aside></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down

0 comments on commit 38d9717

Please sign in to comment.