doc/global.html

<!DOCTYPE html>

<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width">
	<title>listate Global</title>

	<!--[if lt IE 9]>
	<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
	<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">

	<link type="text/css" rel="stylesheet" href="styles/site.spacelab.css">

</head>

<body>

<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
	<div class="navbar-header">
		<a class="navbar-brand" href="index.html">listate</a>
		<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
        </button>
	</div>
	<div class="navbar-collapse collapse" id="topNavigation">
		<ul class="nav navbar-nav">
			
			<li class="dropdown">
				<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="module-listate.html">listate</a></li><li><a href="module-listate_extra.html">listate/extra</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="global.html#listen">listen</a></li>
				</ul>
			</li>
			
		</ul>
        
            <div class="col-sm-3 col-md-3">
                <form class="navbar-form" role="search">
                    <div class="input-group">
                        <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
                        <div class="input-group-btn">
                            <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
                        </div>
                    </div>
                </form>
            </div>
        
	</div>

</div>
</div>


<div class="container" id="toc-content">
<div class="row">

	
	<div class="col-md-8">
	
		<div id="main">
			

	<h1 class="page-title">Global</h1>
<section>

<header>
    
        <h2>
        
        </h2>
        
    
</header>


<article>
    <div class="container-overview">
    
        
<dl class="details">
    

</dl>


    </div>

    
        <h3 class="subsection-title">Methods</h3>

        <dl>
            
<hr>
<dt>
    <h4 class="name" id="listen"><span class="type-signature"></span>listen(store, listener)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Add/register state change listener for the given store.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>store</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="module-listate.html#~Store">module:listate~Store</a></span>


            </td>

            
            <td class="description last"><p>Store for which listener should be added/registered.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>listener</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>
|

<span class="param-type">object</span>


            </td>

            
            <td class="description last"><p>Specifies listener that should be called on a state change.
     Can be a function or an object that defines listener settings/details.</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>handle</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>Listener that should be called on a state change.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>Object that should be used as <code>this</code> value when calling the listener.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>Any data that should be passed into the listener.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>delay</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last"><p>Specifies that listener should be called after the given number of milliseconds have elapsed.
     Works similar to <code>debounce</code>: when several requests for the listener call arrive during the specified period
     only the last one will be applied after the timeout.
     <code>0</code> is acceptable value that means the listener should be called asynchronuosly.
     Negative number means that the listener should be called without delay.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>filter</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    (state) => state
                
                </td>
            

            <td class="description last"><p>Function (selector) to extract state part which will be used inside <code>when</code> to determine
     whether the listener should be called. By default the entire state will be used.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>when</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    baseWhen
                
                </td>
            

            <td class="description last"><p>Function to determine whether the listener should be called.
     The listener will be called if the function returns true.
     The following parameters will be passed into the function:</p>
<ul>
<li>the current state or a part of the current state if <code>filter</code> is set.</li>
<li>the previous state or a part of the previous state if <code>filter</code> is set.</li>
<li>an object that will be passed into listener.</li>
</ul></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="listate.js.html">listate.js</a>,
				 <a href="listate.js.html#sunlight-1-line-127">line 127</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>A function that removes/unsubscribes the listener.</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">function</span>


    </dd>
</dl>


        <h5>Example</h5>
        
    <pre class="sunlight-highlight-javascript">import listen from &#x27;listate&#x27;;const store = createStore(reducer, initState);listen(store, {    filter: (state) =&gt; state.section,    when: (current, prev) =&gt; current !== prev &amp;&amp; current !== &#x27;exit&#x27;,    delay: 1000,    handle: (data) =&gt; {        // data.current === state.section        localStorage.setItem(&#x27;selectedSection&#x27;, data.current);    }});</pre>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="module:listate/extra"><span class="type-signature"></span>module:listate/extra(store, listener)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Add/register state change listener for the given store.</p>
<p>It is a wrap around module:listate.listate that supports enhanced listener settings.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>store</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="module-listate.html#~Store">module:listate~Store</a></span>


            </td>

            
            <td class="description last"><p>Store for which listener should be added/registered.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>listener</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>
|

<span class="param-type">object</span>


            </td>

            
            <td class="description last"><p>Specifies listener that should be called on a state change.
     Can be a function or an object that defines listener settings/details.
     Settings are the same as for module:listate~listate with the following exceptions.</p>
                <h6 class="method-params-label method-subparams-label">Properties</h6>
                

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>filter</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>
|

<span class="param-type">function</span>
|

<span class="param-type">object</span>
|

<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    (state) => state
                
                </td>
            

            <td class="description last"><p>Specifies which state part will be used inside <code>when</code> to determine
     whether the listener should be called.
     When an array or a object is passed, the used filter will be result of
     <a href="module-listate_extra.html#.getPartFilter">getPartFilter(listener.filter)</a>.
     When a string is passed, the used filter will be result of
     <a href="module-listate_extra.html#.getFieldFilter">getFieldFilter(listener.filter)</a>.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>when</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    unlike
                
                </td>
            

            <td class="description last"><p>Function to determine whether the listener should be called.
     By default <a href="module-listate_extra.html#.unlike">unlike</a> is used.</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="extra.js.html">extra.js</a>,
				 <a href="extra.js.html#sunlight-1-line-297">line 297</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>A function that removes/unsubscribes the listener.</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">function</span>


    </dd>
</dl>


</dd>

        </dl>
    

</article>

</section>


		</div>
	</div>

	<div class="clearfix"></div>

	
		<div class="col-md-3">
			<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
		</div>
	

</div>
</div>


    <div class="modal fade" id="searchResults">
      <div class="modal-dialog">
        <div class="modal-content">
          <div class="modal-header">
            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
            <h4 class="modal-title">Search results</h4>
          </div>
          <div class="modal-body"></div>
          <div class="modal-footer">
            <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
          </div>
        </div><!-- /.modal-content -->
      </div><!-- /.modal-dialog -->
    </div>


<footer>


	<span class="copyright">
	Copyright (c) 2017 Denis Sikuler
	</span>

<span class="jsdoc-message">
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
	
		on 2017-06-11T12:51:41+03:00
	
	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>

<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>

    <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>


<script>
$( function () {
	$( "[id*='$']" ).each( function () {
		var $this = $( this );

		$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
	} );

	$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
		var $this = $( this );

		var example = $this.find( "code" );
		exampleText = example.html();
		var lang = /{@lang (.*?)}/.exec( exampleText );
		if ( lang && lang[1] ) {
			exampleText = exampleText.replace( lang[0], "" );
			example.html( exampleText );
			lang = lang[1];
		} else {
			var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
			lang = langClassMatch ? langClassMatch[1] : "javascript";
		}

		if ( lang ) {

			$this
			.addClass( "sunlight-highlight-" + lang )
			.addClass( "linenums" )
			.html( example.html() );

		}
	} );

	Sunlight.highlightAll( {
		lineNumbers : true,
		showMenu : true,
		enableDoclinks : true
	} );

	$.catchAnchorLinks( {
        navbarOffset: 10
	} );
	$( "#toc" ).toc( {
		anchorName  : function ( i, heading, prefix ) {
			return $( heading ).attr( "id" ) || ( prefix + i );
		},
		selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
		showAndHide : false,
		smoothScrolling: true
	} );

	$( "#main span[id^='toc']" ).addClass( "toc-shim" );
	$( '.dropdown-toggle' ).dropdown();

    $( "table" ).each( function () {
      var $this = $( this );
      $this.addClass('table');
    } );

} );
</script>


<!--Navigation and Symbol Display-->


<!--Google Analytics-->


    <script type="text/javascript">
        $(document).ready(function() {
            SearcherDisplay.init();
        });
    </script>


</body>
</html>