Skip to content

Commit ab250ed

Browse files
committed
docs: remove yarn install from README
1 parent 695fe21 commit ab250ed

File tree

3 files changed

+7
-9
lines changed

3 files changed

+7
-9
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -511,8 +511,6 @@ that the mocked Client was called with given Commands.
511511
Matchers are published as a separate package. Install it:
512512

513513
```bash
514-
yarn add -D aws-sdk-client-mock-jest
515-
# or:
516514
npm install -D aws-sdk-client-mock-jest
517515
```
518516

docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ <h2>Usage</h2>
9090
<a href="#install" id="install" style="color: inherit; text-decoration: none;">
9191
<h3>Install</h3>
9292
</a>
93-
<pre><code class="language-bash"><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</span>
93+
<pre><code class="language-bash"><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-4">-D</span><span class="hl-1"> </span><span class="hl-3">aws-sdk-client-mock</span>
9494
</code></pre>
9595
<blockquote>
9696
<p><strong>Warning</strong><br>If you are getting type errors <code>Argument of type &#39;typeof SomeClient&#39; is not assignable to parameter of type...</code>
@@ -283,7 +283,7 @@ <h3>Jest matchers</h3>
283283
<p>Custom <a href="https://jestjs.io/">Jest</a> matchers simplify verification
284284
that the mocked Client was called with given Commands.</p>
285285
<p>Matchers are published as a separate package. Install it:</p>
286-
<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>
286+
<pre><code class="language-bash"><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-4">-D</span><span class="hl-1"> </span><span class="hl-3">aws-sdk-client-mock-jest</span>
287287
</code></pre>
288288
<p>Usage (notice the <code>import</code>):</p>
289289
<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>

docs/interfaces/AwsError.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
5555
</div><aside class="tsd-sources">
5656
<p>Inherited from Partial.$metadata</p>
5757
<ul>
58-
<li>Defined in node_modules/@smithy/types/dist-types/response.d.ts:39</li></ul></aside></section>
58+
<li>Defined in node_modules/.pnpm/@[email protected]/node_modules/@smithy/types/dist-types/response.d.ts:39</li></ul></aside></section>
5959
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="_service" class="tsd-anchor"></a>
6060
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>$service</span><a href="#_service" 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>
6161
<div class="tsd-signature">$service<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -76,25 +76,25 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
7676
<div class="tsd-signature">cause<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
7777
<p>Inherited from Partial.cause</p>
7878
<ul>
79-
<li>Defined in node_modules/typescript/lib/lib.es2022.error.d.ts:26</li></ul></aside></section>
79+
<li>Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26</li></ul></aside></section>
8080
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
8181
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>message</span><a href="#message" 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>
8282
<div class="tsd-signature">message<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
8383
<p>Inherited from Partial.message</p>
8484
<ul>
85-
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1054</li></ul></aside></section>
85+
<li>Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1054</li></ul></aside></section>
8686
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a>
8787
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>name</span><a href="#name" 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>
8888
<div class="tsd-signature">name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
8989
<p>Inherited from Partial.name</p>
9090
<ul>
91-
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1053</li></ul></aside></section>
91+
<li>Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1053</li></ul></aside></section>
9292
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
9393
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" 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>
9494
<div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
9595
<p>Inherited from Partial.stack</p>
9696
<ul>
97-
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1055</li></ul></aside></section></section></div>
97+
<li>Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1055</li></ul></aside></section></section></div>
9898
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
9999
<div class="tsd-navigation settings">
100100
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

0 commit comments

Comments
 (0)