docs/should.html

<!DOCTYPE HTML>
<html lang="en" >
    
    <head>
        
        <meta charset="UTF-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
        <title>should | Redux Actions Assertions</title>
        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
        <meta name="description" content="">
        <meta name="generator" content="GitBook 2.6.7">
        
        
        <meta name="HandheldFriendly" content="true"/>
        <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
        <meta name="apple-mobile-web-app-capable" content="yes">
        <meta name="apple-mobile-web-app-status-bar-style" content="black">
        <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
        <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
        
    <link rel="stylesheet" href="gitbook/style.css">
    
        
        <link rel="stylesheet" href="gitbook/plugins/gitbook-plugin-highlight/website.css">
        
    
        <link rel="stylesheet" href="gitbook/plugins/gitbook-plugin-search/search.css">
        
    
        <link rel="stylesheet" href="gitbook/plugins/gitbook-plugin-fontsettings/website.css">
        
    
    <link rel="next" href="./tape.html" />
    
    
    <link rel="prev" href="./jest.html" />
    

    </head>
    <body>
        
        
    <div class="book"
        data-level="3.6"
        data-chapter-title="should"
        data-filepath="should.md"
        data-basepath="."
        data-revision="Wed Jan 18 2017 12:57:27 GMT+0100 (CET)"
        data-innerlanguage="">
    

<div class="book-summary">
    <nav role="navigation">
        <ul class="summary">
            
            
        <li class="chapter " data-level="0" data-path="index.html">
            
                
                    <a href="./index.html">
                
                        <i class="fa fa-check"></i>
                        
                        Introduction
                    </a>
            
            
        </li>
    
        <li class="chapter " data-level="1" data-path="what_it_does.html">
            
                
                    <a href="./what_it_does.html">
                
                        <i class="fa fa-check"></i>
                        
                            <b>1.</b>
                        
                        What it does
                    </a>
            
            
        </li>
    
        <li class="chapter " data-level="2" data-path="installation.html">
            
                
                    <a href="./installation.html">
                
                        <i class="fa fa-check"></i>
                        
                            <b>2.</b>
                        
                        Installation
                    </a>
            
            
        </li>
    
        <li class="chapter " data-level="3" data-path="javascript.html">
            
                
                    <a href="./javascript.html">
                
                        <i class="fa fa-check"></i>
                        
                            <b>3.</b>
                        
                        API Reference
                    </a>
            
            
            <ul class="articles">
                
    
        <li class="chapter " data-level="3.1" data-path="chai.html">
            
                
                    <a href="./chai.html">
                
                        <i class="fa fa-check"></i>
                        
                            <b>3.1.</b>
                        
                        chai
                    </a>
            
            
        </li>
    
        <li class="chapter " data-level="3.2" data-path="expect.html">
            
                
                    <a href="./expect.html">
                
                        <i class="fa fa-check"></i>
                        
                            <b>3.2.</b>
                        
                        expect
                    </a>
            
            
        </li>
    
        <li class="chapter " data-level="3.3" data-path="expectjs.html">
            
                
                    <a href="./expectjs.html">
                
                        <i class="fa fa-check"></i>
                        
                            <b>3.3.</b>
                        
                        expect.js
                    </a>
            
            
        </li>
    
        <li class="chapter " data-level="3.4" data-path="jasmine.html">
            
                
                    <a href="./jasmine.html">
                
                        <i class="fa fa-check"></i>
                        
                            <b>3.4.</b>
                        
                        jasmine
                    </a>
            
            
        </li>
    
        <li class="chapter " data-level="3.5" data-path="jest.html">
            
                
                    <a href="./jest.html">
                
                        <i class="fa fa-check"></i>
                        
                            <b>3.5.</b>
                        
                        jest
                    </a>
            
            
        </li>
    
        <li class="chapter active" data-level="3.6" data-path="should.html">
            
                
                    <a href="./should.html">
                
                        <i class="fa fa-check"></i>
                        
                            <b>3.6.</b>
                        
                        should
                    </a>
            
            
        </li>
    
        <li class="chapter " data-level="3.7" data-path="tape.html">
            
                
                    <a href="./tape.html">
                
                        <i class="fa fa-check"></i>
                        
                            <b>3.7.</b>
                        
                        tape
                    </a>
            
            
        </li>
    

            </ul>
            
        </li>
    

            <li class="divider"></li>
            <li>
                <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
                    Published with GitBook
                </a>
            </li>
            
        </ul>
    </nav>
</div>

    <div class="book-body">
        <div class="body-inner">
            <div class="book-header" role="navigation">
    <!-- Actions Left -->
    

    <!-- Title -->
    <h1>
        <i class="fa fa-circle-o-notch fa-spin"></i>
        <a href="./" >Redux Actions Assertions</a>
    </h1>
</div>

            <div class="page-wrapper" tabindex="-1" role="main">
                <div class="page-inner">
                
                
                    <section class="normal" id="section-">
                    
                        <h1 id="should"><a href="https://github.com/shouldjs/should.js" target="_blank">should</a></h1>
<h2 id="registration">Registration</h2>
<pre><code class="lang-js"><span class="hljs-comment">// using ES6 modules</span>
<span class="hljs-keyword">import</span> { registerAssertions } <span class="hljs-keyword">from</span> <span class="hljs-string">&apos;redux-actions-assertions/should&apos;</span>;

<span class="hljs-comment">// using CommonJS modules</span>
<span class="hljs-keyword">var</span> registerAssertions = <span class="hljs-built_in">require</span>(<span class="hljs-string">&apos;redux-actions-assertions/should&apos;</span>).registerAssertions;

<span class="hljs-comment">// registration</span>
registerAssertions();
</code></pre>
<h2 id="usage">Usage</h2>
<h3 id="dispatchactions">.dispatchActions</h3>
<blockquote>
<p><code>should(action).dispatchActions(expectedActions, callback)</code>
<code>action.should.dispatchActions(expectedActions, callback)</code></p>
</blockquote>
<p>Asserts that when given <code>action</code> is dispatched it will dispatch <code>expectedActions</code>. <code>action</code> can be plain object (action) or function (action creator). <code>expectedActions</code> can be can be plain object (action) or function (action creator) or array of objects/functions.</p>
<pre><code class="lang-js">should(myActionCreator())
  .dispatchActions({ type: <span class="hljs-string">&apos;MY_ACTION_START&apos;</span> }, callback);

myActionCreator().should
  .dispatchActions({ type: <span class="hljs-string">&apos;MY_ACTION_START&apos;</span> }, callback);
</code></pre>
<h3 id="notdispatchactions">.notDispatchActions</h3>
<blockquote>
<p><code>should(action).notDispatchActions(expectedActions, callback)</code>
<code>action.should.notDispatchActions(expectedActions, callback)</code></p>
</blockquote>
<p>Asserts that when given <code>action</code> is dispatched it will not dispatch <code>expectedActions</code>. <code>action</code> can be plain object (action) or function (action creator). <code>expectedActions</code> can be can be plain object (action) or function (action creator) or array of objects/functions.</p>
<pre><code class="lang-js">should(myActionCreator())
  .notDispatchActions({ type: <span class="hljs-string">&apos;MY_ACTION_START&apos;</span> }, callback);

myActionCreator().should
  .notDispatchActions({ type: <span class="hljs-string">&apos;MY_ACTION_START&apos;</span> }, callback);
</code></pre>
<h3 id="withstate-or-withstate">.withState or with.state</h3>
<blockquote>
<p><code>should(action).withState(state).dispatchActions(expectedActions, callback)</code>
<code>should(action).with.state(state).dispatchActions(expectedActions, callback)</code></p>
<p><code>action.should.withState(state).dispatchActions(expectedActions, callback)</code>
<code>action.should.with.state(state).dispatchActions(expectedActions, callback)</code></p>
</blockquote>
<p>Asserts that store initialised with <code>state</code> before <code>action</code> is dispatched.</p>
<pre><code class="lang-js">should(myActionCreator())
  .withState({ property: <span class="hljs-string">&apos;value&apos;</span> })
  .dispatchActions({ type: <span class="hljs-string">&apos;MY_ACTION_START&apos;</span> }, callback);

should(myActionCreator())
  .with.state({ property: <span class="hljs-string">&apos;value&apos;</span> })
  .dispatchActions({ type: <span class="hljs-string">&apos;MY_ACTION_START&apos;</span> }, callback);

myActionCreator().should
  .withState({ property: <span class="hljs-string">&apos;value&apos;</span> })
  .dispatchActions({ type: <span class="hljs-string">&apos;MY_ACTION_START&apos;</span> }, callback);

myActionCreator().should
  .with.state({ property: <span class="hljs-string">&apos;value&apos;</span> })
  .dispatchActions({ type: <span class="hljs-string">&apos;MY_ACTION_START&apos;</span> }, callback);
</code></pre>

                    
                    </section>
                
                
                </div>
            </div>
        </div>

        
        <a href="./jest.html" class="navigation navigation-prev " aria-label="Previous page: jest"><i class="fa fa-angle-left"></i></a>
        
        
        <a href="./tape.html" class="navigation navigation-next " aria-label="Next page: tape"><i class="fa fa-angle-right"></i></a>
        
    </div>
</div>

        
<script src="gitbook/app.js"></script>

    
    <script src="gitbook/plugins/gitbook-plugin-ga/plugin.js"></script>
    

    <script src="gitbook/plugins/gitbook-plugin-search/lunr.min.js"></script>
    

    <script src="gitbook/plugins/gitbook-plugin-search/search.js"></script>
    

    <script src="gitbook/plugins/gitbook-plugin-sharing/buttons.js"></script>
    

    <script src="gitbook/plugins/gitbook-plugin-fontsettings/buttons.js"></script>
    

<script>
require(["gitbook"], function(gitbook) {
    var config = {"ga":{"token":"UA-78823490-1","configuration":"auto"},"highlight":{},"search":{"maxIndexSize":1000000},"sharing":{"facebook":false,"twitter":false,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"],"website":false},"fontsettings":{"theme":"white","family":"sans","size":2}};
    gitbook.start(config);
});
</script>

        
    </body>
    
</html>