casraf/express-otp
1
0
Fork 0
mirror of https://github.com/chenasraf/express-otp.git synced 2026-05-18 01:49:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: e314e67c0b

Browse Source
This commit is contained in:
chenasraf
2022-11-29 10:45:15 +00:00
parent 91375b1444
commit ae7900ce74
10 changed files with 55 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
classes/OTPError.html
View File

@@ -23,7 +23,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">OTPError</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/error.ts#L13">error.ts:13</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/error.ts#L13">error.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">
@@ -59,7 +59,7 @@
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="OTPError.html" class="tsd-signature-type" data-tsd-kind="Class">OTPError</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/error.ts#L18">error.ts:18</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/error.ts#L18">error.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-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a>
@@ -68,7 +68,7 @@
<div class="tsd-comment tsd-typography"><p>The type of error.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/error.ts#L18">error.ts:18</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/error.ts#L18">error.ts:18</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="message" class="tsd-anchor"></a>
@@ -80,7 +80,7 @@
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/error.ts#L23">error.ts:23</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/error.ts#L23">error.ts:23</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

2
functions/default.html
View File

@@ -31,7 +31,7 @@
<h5>_options: <a href="../interfaces/TotpOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TotpOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/TotpApiOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TotpApiOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/TotpMiddlewares.html" class="tsd-signature-type" data-tsd-kind="Interface">TotpMiddlewares</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/auth.ts#L19">auth.ts:19</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/auth.ts#L19">auth.ts:19</a></li></ul></aside></li></ul></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

21
index.html
View File

File diff suppressed because one or more lines are too long

12
interfaces/TokenFormOptions.html
View File

@@ -23,7 +23,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">TokenFormOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L110">types.ts:110</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L110">types.ts:110</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">
@@ -45,35 +45,35 @@
<div class="tsd-comment tsd-typography"><p>Custom HTML to append after the form, inside the <main> element.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L120">types.ts:120</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L120">types.ts:120</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="css" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>css</span><a href="#css" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">css<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Custom CSS to add to the page. Is appended at the end of <head>.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L114">types.ts:114</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L114">types.ts:114</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="js" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>js</span><a href="#js" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">js<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Custom JS to add to the page. Is appended at the end of <body>.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L116">types.ts:116</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L116">types.ts:116</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="prependHtml" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>prepend<wbr/>Html</span><a href="#prependHtml" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">prepend<wbr/>Html<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Custom HTML to prepend before the title, inside the <main> element.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L118">types.ts:118</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L118">types.ts:118</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="texts" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>texts</span><a href="#texts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">texts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;title&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;promptTitle&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;promptDescription&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;submitButton&quot;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-comment tsd-typography"><p>A mapping of text labels to use in the form.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L112">types.ts:112</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L112">types.ts:112</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

12
interfaces/TotpApiOptions.html
View File

@@ -25,7 +25,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">TotpApiOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L52">types.ts:52</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L52">types.ts:52</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">
@@ -54,14 +54,14 @@ redirecting or otherwise handling the request in this case.</p>
<p>This only works for GET requests, as it will redirect to the same URL with the token as a query parameter.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L99">types.ts:99</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L99">types.ts:99</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tokenFormOptions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>token<wbr/>Form<wbr/>Options</span><a href="#tokenFormOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">token<wbr/>Form<wbr/>Options<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="TokenFormOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TokenFormOptions</a><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-comment tsd-typography"><p>Options for generating the token form.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L104">types.ts:104</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L104">types.ts:104</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="errorResponse" class="tsd-anchor"></a>
@@ -91,7 +91,7 @@ The response ends after this function is called.</p>
<h5>reason: <a href="../classes/OTPError.html" class="tsd-signature-type" data-tsd-kind="Class">OTPError</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L88">types.ts:88</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L88">types.ts:88</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getToken" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>get<wbr/>Token</span><a href="#getToken" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
@@ -110,7 +110,7 @@ The response ends after this function is called.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PromiseOrValue</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L78">types.ts:78</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L78">types.ts:78</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getUser" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>User</span><a href="#getUser" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
@@ -137,7 +137,7 @@ checking headers, etc.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PromiseOrValue</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="UserData.html" class="tsd-signature-type" data-tsd-kind="Interface">UserData</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L70">types.ts:70</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L70">types.ts:70</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

18
interfaces/TotpMiddlewares.html
View File

@@ -25,7 +25,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">TotpMiddlewares</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L128">types.ts:128</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L128">types.ts:128</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">
@@ -91,7 +91,7 @@ further requests.</li>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></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">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L137">types.ts:137</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L137">types.ts:137</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="generateNewSecret" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>generate<wbr/>New<wbr/>Secret</span><a href="#generateNewSecret" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
@@ -101,7 +101,7 @@ further requests.</li>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L190">types.ts:190</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L190">types.ts:190</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="generateSecretQR" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>generate<wbr/>SecretQR</span><a href="#generateSecretQR" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
@@ -125,7 +125,7 @@ further requests.</li>
</div></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">string</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L161">types.ts:161</a></li></ul></aside></li>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L161">types.ts:161</a></li></ul></aside></li>
<li class="tsd-signature tsd-anchor-link" id="generateSecretQR.generateSecretQR-2">generate<wbr/>SecretQR<span class="tsd-signature-symbol">(</span>username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, secret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filename<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#generateSecretQR.generateSecretQR-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Function for generating a QR code for a user from a given <code>secret</code> and <code>username</code>.</p>
@@ -148,7 +148,7 @@ further requests.</li>
</div></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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L172">types.ts:172</a></li></ul></aside></li>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L172">types.ts:172</a></li></ul></aside></li>
<li class="tsd-signature tsd-anchor-link" id="generateSecretQR.generateSecretQR-3">generate<wbr/>SecretQR<span class="tsd-signature-symbol">(</span>username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, secret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filename<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#generateSecretQR.generateSecretQR-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Function for generating a QR code for a user from a given <code>secret</code> and <code>username</code>.</p>
@@ -175,7 +175,7 @@ user.</li>
</div></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">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L185">types.ts:185</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L185">types.ts:185</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="generateSecretURL" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>generate<wbr/>SecretURL</span><a href="#generateSecretURL" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
@@ -198,7 +198,7 @@ user.</li>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L149">types.ts:149</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L149">types.ts:149</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="verifyToken" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>verify<wbr/>Token</span><a href="#verifyToken" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
@@ -222,7 +222,7 @@ secret, it returns <code>true</code>. Otherwise, it returns <code>false</code>.<
</div></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/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L201">types.ts:201</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L201">types.ts:201</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="verifyUser" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>verify<wbr/>User</span><a href="#verifyUser" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
@@ -241,7 +241,7 @@ secret, it returns <code>true</code>. Otherwise, it returns <code>false</code>.<
</div></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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L209">types.ts:209</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L209">types.ts:209</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

12
interfaces/TotpOptions.html
View File

@@ -20,7 +20,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">TotpOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L14">types.ts:14</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L14">types.ts:14</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">
@@ -43,35 +43,35 @@
SHA3-224, SHA3-256, SHA3-384, SHA3-512, SHAKE128, or SHAKE256).</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L23">types.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L23">types.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="digits" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>digits</span><a href="#digits" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">digits<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>Amount of token digits to use. Defaults to 6</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L36">types.ts:36</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L36">types.ts:36</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="issuer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>issuer</span><a href="#issuer" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">issuer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The issuer for your app (required)</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L16">types.ts:16</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L16">types.ts:16</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="period" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>period</span><a href="#period" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">period<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>The time it takes for a new token to generate, in seconds. Defaults to 30</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L18">types.ts:18</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L18">types.ts:18</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="timestamp" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>timestamp</span><a href="#timestamp" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">timestamp<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>The epoch time. Defaults to 0 (unix epoch)</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L38">types.ts:38</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L38">types.ts:38</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

8
interfaces/UserData.html
View File

@@ -25,7 +25,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">UserData</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L41">types.ts:41</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L41">types.ts:41</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">
@@ -45,21 +45,21 @@
<div class="tsd-comment tsd-typography"><p>The secret key of the user, used for generating a comparison key.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L45">types.ts:45</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L45">types.ts:45</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="user" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>user</span><a href="#user" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">user<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span></div>
<div class="tsd-comment tsd-typography"><p>The user object that will get injected into further requests.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L43">types.ts:43</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L43">types.ts:43</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="username" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>username</span><a href="#username" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The username used for generating the token URL/QR.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L47">types.ts:47</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L47">types.ts:47</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

2
types/AuthOptions.html
View File

@@ -24,7 +24,7 @@
<li>
<h4>U</h4></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/types.ts#L126">types.ts:126</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/types.ts#L126">types.ts:126</a></li></ul></aside></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

2
types/OTPErrorReason.html
View File

@@ -24,7 +24,7 @@
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/98ee2ef/src/error.ts#L8">error.ts:8</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/chenasraf/express-otp/blob/e314e67/src/error.ts#L8">error.ts:8</a></li></ul></aside></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">