Skip to content

Commit

Permalink
chore(docs): automated update typedocs after release [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
connorjburton committed Mar 30, 2024
1 parent 812740e commit 80bcc63
Show file tree
Hide file tree
Showing 12 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/assets/navigation.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/assets/search.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions docs/classes/AuthError.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">AuthError</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/9a6d11a/src/errors.ts#L1">src/errors.ts:1</a></li></ul></aside>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/812740e/src/errors.ts#L1">src/errors.ts:1</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 @@ -64,7 +64,7 @@ <h5><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-
<h4 class="tsd-returns-title">Returns <a href="AuthError.html" class="tsd-signature-type tsd-kind-class">AuthError</a></h4><aside class="tsd-sources">
<p>Overrides Error.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/9a6d11a/src/errors.ts#L7">src/errors.ts:7</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/812740e/src/errors.ts#L7">src/errors.ts:7</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-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a>
Expand All @@ -77,7 +77,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
<h3 class="tsd-anchor-link"><span>code</span><a href="#code" 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">code</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/connorjburton/hmac-auth-express/blob/9a6d11a/src/errors.ts#L2">src/errors.ts:2</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/812740e/src/errors.ts#L2">src/errors.ts:2</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>message</span><a href="#message" 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">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
Expand All @@ -100,17 +100,17 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
<h3 class="tsd-anchor-link"><span>status</span><a href="#status" 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">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/9a6d11a/src/errors.ts#L3">src/errors.ts:3</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/812740e/src/errors.ts#L3">src/errors.ts:3</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="statusCode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>status<wbr/>Code</span><a href="#statusCode" 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">status<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/9a6d11a/src/errors.ts#L4">src/errors.ts:4</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/812740e/src/errors.ts#L4">src/errors.ts:4</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="status_code" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>status_<wbr/>code</span><a href="#status_code" 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">status_<wbr/>code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/9a6d11a/src/errors.ts#L5">src/errors.ts:5</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/812740e/src/errors.ts#L5">src/errors.ts:5</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
<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>
<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>
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/HMAC.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ <h5><span class="tsd-kind-parameter">secret</span>: <a href="../types/DynamicSec
<h5><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Options.html" class="tsd-signature-type tsd-kind-interface">Options</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">RequestHandler</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/9a6d11a/src/index.ts#L80">src/index.ts:80</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/812740e/src/index.ts#L80">src/index.ts:80</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/generate.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/GenerateOptions.html" class="tsd-signature-type tsd-kind-interface">GenerateOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Hmac</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/9a6d11a/src/generate.ts#L27">src/generate.ts:27</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/812740e/src/generate.ts#L27">src/generate.ts:27</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/order-1.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">o</span>: <a href="../types/UnknownObject.html" class="tsd-signature-type tsd-kind-type-alias">UnknownObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../types/UnknownObject.html" class="tsd-signature-type tsd-kind-type-alias">UnknownObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/9a6d11a/src/order.ts#L3">src/order.ts:3</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/812740e/src/order.ts#L3">src/order.ts:3</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/GenerateOptions.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">GenerateOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/9a6d11a/src/generate.ts#L4">src/generate.ts:4</a></li></ul></aside>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/812740e/src/generate.ts#L4">src/generate.ts:4</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 All @@ -36,7 +36,7 @@ <h2>Properties</h2>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>order</span><a href="#order" 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">order</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Order.html" class="tsd-signature-type tsd-kind-type-alias">Order</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/9a6d11a/src/generate.ts#L5">src/generate.ts:5</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/812740e/src/generate.ts#L5">src/generate.ts:5</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading

0 comments on commit 80bcc63

Please sign in to comment.