Skip to content

Commit 65f0d01

Browse files
github-actions[bot]github-actions[bot]
committed
docs: update docs website
1 parent 19f041a commit 65f0d01

10 files changed

+156
-200
lines changed

‎docs/classes/AwsStub.html

+45-29
Large diffs are not rendered by default.

‎docs/classes/CommandBehavior.html

+49-49
Large diffs are not rendered by default.

‎docs/functions/mockClient.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>mockClient | AWS SDK v3 Client mock - v4.0.0</title><meta name="description" content="Documentation for AWS SDK v3 Client mock - v4.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>mockClient | AWS SDK v3 Client mock - v4.0.1</title><meta name="description" content="Documentation for AWS SDK v3 Client mock - v4.0.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
22
<div class="tsd-toolbar-contents container">
33
<div class="table-cell" id="tsd-search" data-base="..">
44
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
55
<div class="field">
66
<div id="tsd-toolbar-links"></div></div>
77
<ul class="results">
88
<li class="state loading">Preparing search index...</li>
9-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">AWS SDK v3 Client mock - v4.0.0</a></div>
9+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">AWS SDK v3 Client mock - v4.0.1</a></div>
1010
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
1111
<div class="container container-main">
1212
<div class="col-8 col-content">
1313
<div class="tsd-page-title">
1414
<ul class="tsd-breadcrumb">
15-
<li><a href="../modules.html">AWS SDK v3 Client mock - v4.0.0</a></li>
15+
<li><a href="../modules.html">AWS SDK v3 Client mock - v4.0.1</a></li>
1616
<li><a href="mockClient.html">mockClient</a></li></ul>
1717
<h1>Function mockClient</h1></div>
1818
<section class="tsd-panel">
@@ -67,7 +67,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
6767
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
6868
<div class="tsd-accordion-details">
6969
<ul>
70-
<li><a href="../modules.html">AWS SDK v3 <wbr/>Client mock -<wbr/> v4.0.0</a>
70+
<li><a href="../modules.html">AWS SDK v3 <wbr/>Client mock -<wbr/> v4.0.1</a>
7171
<ul></ul></li></ul></div></details></nav>
7272
<nav class="tsd-navigation secondary menu-sticky">
7373
<ul>

‎docs/index.html

+11-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AWS SDK v3 Client mock - v4.0.0</title><meta name="description" content="Documentation for AWS SDK v3 Client mock - v4.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AWS SDK v3 Client mock - v4.0.1</title><meta name="description" content="Documentation for AWS SDK v3 Client mock - v4.0.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
22
<div class="tsd-toolbar-contents container">
33
<div class="table-cell" id="tsd-search" data-base=".">
44
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
55
<div class="field">
66
<div id="tsd-toolbar-links"></div></div>
77
<ul class="results">
88
<li class="state loading">Preparing search index...</li>
9-
<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">AWS SDK v3 Client mock - v4.0.0</a></div>
9+
<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">AWS SDK v3 Client mock - v4.0.1</a></div>
1010
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
1111
<div class="container container-main">
1212
<div class="col-8 col-content">
1313
<div class="tsd-page-title">
14-
<h2>AWS SDK v3 Client mock - v4.0.0</h2></div>
14+
<h2>AWS SDK v3 Client mock - v4.0.1</h2></div>
1515
<div class="tsd-panel tsd-typography"><div align="center">
1616

1717

@@ -109,7 +109,7 @@ <h4>Versions compatibility</h4>
109109
</thead>
110110
<tbody><tr>
111111
<td>≥ 3.363.0</td>
112-
<td>3.x</td>
112+
<td>≥ 3.x</td>
113113
</tr>
114114
<tr>
115115
<td>&lt; 3.363.0</td>
@@ -164,6 +164,11 @@ <h3>Mock</h3>
164164
<p>Specify mock throwing an error:</p>
165165
<pre><code class="language-typescript"><span class="hl-2">snsMock</span><br/><span class="hl-1"> .</span><span class="hl-6">rejects</span><span class="hl-1">(</span><span class="hl-3">&#39;mocked rejection&#39;</span><span class="hl-1">);</span>
166166
</code></pre>
167+
<pre><code class="language-typescript"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">throttlingError</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Error</span><span class="hl-1">(</span><span class="hl-3">&#39;mocked rejection&#39;</span><span class="hl-1">);</span><br/><span class="hl-2">throttlingError</span><span class="hl-1">.</span><span class="hl-2">name</span><span class="hl-1"> = </span><span class="hl-3">&#39;ThrottlingException&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-2">snsMock</span><br/><span class="hl-1"> .</span><span class="hl-6">rejects</span><span class="hl-1">(</span><span class="hl-2">throttlingError</span><span class="hl-1">);</span>
168+
</code></pre>
169+
<p>In <code>rejects()</code>, you can pass a string, an <code>Error</code> instance,
170+
or an object with properties.
171+
In each case, it will be converted to an <code>Error</code> instance.</p>
167172
<p>Specify custom mock function:</p>
168173
<pre><code class="language-typescript"><span class="hl-2">snsMock</span><br/><span class="hl-1"> .</span><span class="hl-6">callsFake</span><span class="hl-1">(</span><span class="hl-2">input</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (</span><span class="hl-2">input</span><span class="hl-1">.</span><span class="hl-2">Message</span><span class="hl-1"> === </span><span class="hl-3">&#39;My message&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> {</span><span class="hl-2">MessageId:</span><span class="hl-1"> </span><span class="hl-3">&#39;12345678-1111-2222-3333-111122223333&#39;</span><span class="hl-1">};</span><br/><span class="hl-1"> } </span><span class="hl-0">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">throw</span><span class="hl-1"> </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Error</span><span class="hl-1">(</span><span class="hl-3">&#39;mocked rejection&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> });</span>
169174
</code></pre>
@@ -281,7 +286,7 @@ <h3>Jest matchers</h3>
281286
<pre><code class="language-bash"><span class="hl-1">yarn </span><span class="hl-3">add</span><span class="hl-1"> </span><span class="hl-3">-D</span><span class="hl-1"> </span><span class="hl-3">aws-sdk-client-mock-jest</span><br/><span class="hl-8"># or:</span><br/><span class="hl-1">npm </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">-D</span><span class="hl-1"> </span><span class="hl-3">aws-sdk-client-mock-jest</span>
282287
</code></pre>
283288
<p>Usage (notice the <code>import</code>):</p>
284-
<pre><code class="language-ts"><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-3">&#39;aws-sdk-client-mock-jest&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-8">// a PublishCommand was sent to SNS</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedCommand</span><span class="hl-1">(</span><span class="hl-2">PublishCommand</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// Any command was sent to SNS</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedAnyCommand</span><span class="hl-1">();</span><br/><br/><span class="hl-8">// two PublishCommands were sent to SNS</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedCommandTimes</span><span class="hl-1">(</span><span class="hl-2">PublishCommand</span><span class="hl-1">, </span><span class="hl-9">2</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// a PublishCommand with Message &quot;My message&quot; was sent to SNS</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedCommandWith</span><span class="hl-1">(</span><span class="hl-2">PublishCommand</span><span class="hl-1">, {</span><span class="hl-2">Message:</span><span class="hl-1"> </span><span class="hl-3">&#39;My message&#39;</span><span class="hl-1">});</span><br/><br/><span class="hl-8">// the second command sent to SNS is a PublishCommand with Message &quot;My message&quot;</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedNthCommandWith</span><span class="hl-1">(</span><span class="hl-9">2</span><span class="hl-1">, </span><span class="hl-2">PublishCommand</span><span class="hl-1">, {</span><span class="hl-2">Message:</span><span class="hl-1"> </span><span class="hl-3">&#39;My message&#39;</span><span class="hl-1">});</span><br/><br/><span class="hl-8">// the second PublishCommand sent to SNS has Message &quot;My message&quot;</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedNthSpecificCommandWith</span><span class="hl-1">(</span><span class="hl-9">2</span><span class="hl-1">, </span><span class="hl-2">PublishCommand</span><span class="hl-1">, {</span><span class="hl-2">Message:</span><span class="hl-1"> </span><span class="hl-3">&#39;My message&#39;</span><span class="hl-1">});</span>
289+
<pre><code class="language-ts"><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-3">&#39;aws-sdk-client-mock-jest&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-8">// a PublishCommand was sent to SNS</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedCommand</span><span class="hl-1">(</span><span class="hl-2">PublishCommand</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// at least one command was sent to SNS</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedAnyCommand</span><span class="hl-1">();</span><br/><br/><span class="hl-8">// two PublishCommands were sent to SNS</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedCommandTimes</span><span class="hl-1">(</span><span class="hl-2">PublishCommand</span><span class="hl-1">, </span><span class="hl-9">2</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// a PublishCommand with Message &quot;hello world&quot; was sent to SNS</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedCommandWith</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">PublishCommand</span><span class="hl-1">, {</span><span class="hl-2">Message:</span><span class="hl-1"> </span><span class="hl-3">&#39;hello world&#39;</span><span class="hl-1">}</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-8">// a PublishCommand with Message containing &quot;hello&quot; was sent to SNS</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedCommandWith</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">PublishCommand</span><span class="hl-1">, {</span><span class="hl-2">Message:</span><span class="hl-1"> </span><span class="hl-2">expect</span><span class="hl-1">.</span><span class="hl-6">stringContaining</span><span class="hl-1">(</span><span class="hl-3">&#39;hello&#39;</span><span class="hl-1">)}</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-8">// the second command sent to SNS was a PublishCommand with Message &quot;hello world&quot;</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedNthCommandWith</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-9">2</span><span class="hl-1">, </span><span class="hl-2">PublishCommand</span><span class="hl-1">, {</span><span class="hl-2">Message:</span><span class="hl-1"> </span><span class="hl-3">&#39;hello world&#39;</span><span class="hl-1">}</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-8">// the second PublishCommand sent to SNS had Message &quot;hello world&quot;</span><br/><span class="hl-6">expect</span><span class="hl-1">(</span><span class="hl-2">snsMock</span><span class="hl-1">).</span><span class="hl-6">toHaveReceivedNthSpecificCommandWith</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-9">2</span><span class="hl-1">, </span><span class="hl-2">PublishCommand</span><span class="hl-1">, {</span><span class="hl-2">Message:</span><span class="hl-1"> </span><span class="hl-3">&#39;hello world&#39;</span><span class="hl-1">}</span><br/><span class="hl-1">);</span>
285290
</code></pre>
286291
<p>Shorter aliases exist, like <code>toReceiveCommandTimes()</code>. </p>
287292
<p>To use those matchers with <a href="https://vitest.dev/">Vitest</a>, set <code>test.globals</code> to <code>true</code> in <code>vite.config.js</code>
@@ -403,7 +408,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
403408
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
404409
<div class="tsd-accordion-details">
405410
<ul>
406-
<li class="current selected"><a href="modules.html">AWS SDK v3 <wbr/>Client mock -<wbr/> v4.0.0</a>
411+
<li class="current selected"><a href="modules.html">AWS SDK v3 <wbr/>Client mock -<wbr/> v4.0.1</a>
407412
<ul></ul></li></ul></div></details></nav>
408413
<nav class="tsd-navigation secondary menu-sticky">
409414
<ul>

0 commit comments

Comments
 (0)