337 lines
16 KiB
HTML
337 lines
16 KiB
HTML
|
<!doctype html>
|
||
|
|
<html class="default no-js">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
|
<title>UpduxMiddlewareAPI | updux</title>
|
||
|
|
<meta name="description" content="">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<header>
|
||
|
|
<div class="tsd-page-toolbar">
|
||
|
|
<div class="container">
|
||
|
|
<div class="table-wrap">
|
||
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||
|
|
<div class="field">
|
||
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||
|
|
<input id="tsd-search-field" type="text" />
|
||
|
|
</div>
|
||
|
|
<ul class="results">
|
||
|
|
<li class="state loading">Preparing search index...</li>
|
||
|
|
<li class="state failure">The search index is not available</li>
|
||
|
|
</ul>
|
||
|
|
<a href="../index.html" class="title">updux</a>
|
||
|
|
</div>
|
||
|
|
<div class="table-cell" id="tsd-widgets">
|
||
|
|
<div id="tsd-filter">
|
||
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||
|
|
<div class="tsd-filter-group">
|
||
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
||
|
|
<span class="tsd-select-label">All</span>
|
||
|
|
<ul class="tsd-select-list">
|
||
|
|
<li data-value="public">Public</li>
|
||
|
|
<li data-value="protected">Public/Protected</li>
|
||
|
|
<li data-value="private" class="selected">All</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
||
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
||
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="tsd-page-title">
|
||
|
|
<div class="container">
|
||
|
|
<ul class="tsd-breadcrumb">
|
||
|
|
<li>
|
||
|
|
<a href="../globals.html">Globals</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="upduxmiddlewareapi.html">UpduxMiddlewareAPI</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h1>Interface UpduxMiddlewareAPI<S></h1>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</header>
|
||
|
|
<div class="container container-main">
|
||
|
|
<div class="row">
|
||
|
|
<div class="col-8 col-content">
|
||
|
|
<section class="tsd-panel tsd-type-parameters">
|
||
|
|
<h3>Type parameters</h3>
|
||
|
|
<ul class="tsd-type-parameters">
|
||
|
|
<li>
|
||
|
|
<h4>S</h4>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-hierarchy">
|
||
|
|
<h3>Hierarchy</h3>
|
||
|
|
<ul class="tsd-hierarchy">
|
||
|
|
<li>
|
||
|
|
<span class="target">UpduxMiddlewareAPI</span>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel-group tsd-index-group">
|
||
|
|
<h2>Index</h2>
|
||
|
|
<section class="tsd-panel tsd-index-panel">
|
||
|
|
<div class="tsd-index-content">
|
||
|
|
<section class="tsd-index-section ">
|
||
|
|
<h3>Properties</h3>
|
||
|
|
<ul class="tsd-index-list">
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="upduxmiddlewareapi.html#dispatch" class="tsd-kind-icon">dispatch</a></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-index-section ">
|
||
|
|
<h3>Methods</h3>
|
||
|
|
<ul class="tsd-index-list">
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="upduxmiddlewareapi.html#getrootstate" class="tsd-kind-icon">get<wbr>Root<wbr>State</a></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="upduxmiddlewareapi.html#getstate" class="tsd-kind-icon">get<wbr>State</a></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel-group tsd-member-group ">
|
||
|
|
<h2>Properties</h2>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||
|
|
<a name="dispatch" class="tsd-anchor"></a>
|
||
|
|
<h3>dispatch</h3>
|
||
|
|
<div class="tsd-signature tsd-kind-icon">dispatch<span class="tsd-signature-symbol">:</span> <a href="../globals.html#upduxdispatch" class="tsd-signature-type">UpduxDispatch</a></div>
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/yanick/updux/blob/8d4542f/src/types.ts#L187">types.ts:187</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel-group tsd-member-group ">
|
||
|
|
<h2>Methods</h2>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||
|
|
<a name="getrootstate" class="tsd-anchor"></a>
|
||
|
|
<h3>get<wbr>Root<wbr>State</h3>
|
||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Root<wbr>State<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">S</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/yanick/updux/blob/8d4542f/src/types.ts#L189">types.ts:189</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">S</span></h4>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||
|
|
<a name="getstate" class="tsd-anchor"></a>
|
||
|
|
<h3>get<wbr>State</h3>
|
||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>State<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/yanick/updux/blob/8d4542f/src/types.ts#L188">types.ts:188</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||
|
|
<nav class="tsd-navigation primary">
|
||
|
|
<ul>
|
||
|
|
<li class="globals ">
|
||
|
|
<a href="../globals.html"><em>Globals</em></a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
||
|
|
<ul class="before-current">
|
||
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
||
|
|
<a href="../classes/updux.html" class="tsd-kind-icon">Updux</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<ul class="current">
|
||
|
|
<li class="current tsd-kind-interface tsd-has-type-parameter">
|
||
|
|
<a href="upduxmiddlewareapi.html" class="tsd-kind-icon">Updux<wbr>MiddlewareAPI</a>
|
||
|
|
<ul>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||
|
|
<a href="upduxmiddlewareapi.html#dispatch" class="tsd-kind-icon">dispatch</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||
|
|
<a href="upduxmiddlewareapi.html#getrootstate" class="tsd-kind-icon">get<wbr>Root<wbr>State</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||
|
|
<a href="upduxmiddlewareapi.html#getstate" class="tsd-kind-icon">get<wbr>State</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<ul class="after-current">
|
||
|
|
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#action" class="tsd-kind-icon">Action</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#actioncreator" class="tsd-kind-icon">Action<wbr>Creator</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
||
|
|
<a href="../globals.html#actionpair" class="tsd-kind-icon">Action<wbr>Pair</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias">
|
||
|
|
<a href="../globals.html#actionpayloadgenerator" class="tsd-kind-icon">Action<wbr>Payload<wbr>Generator</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#dictionary" class="tsd-kind-icon">Dictionary</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#dux" class="tsd-kind-icon">Dux</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias tsd-has-type-parameter tsd-is-not-exported">
|
||
|
|
<a href="../globals.html#maybepayload" class="tsd-kind-icon">Maybe<wbr>Payload</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#mutation" class="tsd-kind-icon">Mutation</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
||
|
|
<a href="../globals.html#next" class="tsd-kind-icon">Next</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias tsd-has-type-parameter tsd-is-not-exported">
|
||
|
|
<a href="../globals.html#storewithdispatchactions" class="tsd-kind-icon">Store<wbr>With<wbr>Dispatch<wbr>Actions</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
||
|
|
<a href="../globals.html#submutations" class="tsd-kind-icon">Sub<wbr>Mutations</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#upduxconfig" class="tsd-kind-icon">Updux<wbr>Config</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias">
|
||
|
|
<a href="../globals.html#upduxdispatch" class="tsd-kind-icon">Updux<wbr>Dispatch</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#upduxmiddleware" class="tsd-kind-icon">Updux<wbr>Middleware</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#upreducer" class="tsd-kind-icon">Upreducer</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-function tsd-is-not-exported">
|
||
|
|
<a href="../globals.html#middlewarefor" class="tsd-kind-icon">Middleware<wbr>For</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#actioncreator" class="tsd-kind-icon">action<wbr>Creator</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-function tsd-is-not-exported">
|
||
|
|
<a href="../globals.html#actionfor" class="tsd-kind-icon">action<wbr>For</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-function">
|
||
|
|
<a href="../globals.html#buildactions" class="tsd-kind-icon">build<wbr>Actions</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#buildcreatestore" class="tsd-kind-icon">build<wbr>Create<wbr>Store</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#buildinitial" class="tsd-kind-icon">build<wbr>Initial</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#buildmiddleware" class="tsd-kind-icon">build<wbr>Middleware</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-function">
|
||
|
|
<a href="../globals.html#buildmutations" class="tsd-kind-icon">build<wbr>Mutations</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-function tsd-has-type-parameter">
|
||
|
|
<a href="../globals.html#buildupreducer" class="tsd-kind-icon">build<wbr>Upreducer</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-function tsd-is-not-exported">
|
||
|
|
<a href="../globals.html#composemutations" class="tsd-kind-icon">compose<wbr>Mutations</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-function tsd-is-not-exported">
|
||
|
|
<a href="../globals.html#slicemw" class="tsd-kind-icon">slice<wbr>Mw</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<footer class="with-border-bottom">
|
||
|
|
<div class="container">
|
||
|
|
<h2>Legend</h2>
|
||
|
|
<div class="tsd-legend-group">
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||
|
|
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||
|
|
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||
|
|
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||
|
|
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||
|
|
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||
|
|
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</footer>
|
||
|
|
<div class="container tsd-generator">
|
||
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||
|
|
</div>
|
||
|
|
<div class="overlay"></div>
|
||
|
|
<script src="../assets/js/main.js"></script>
|
||
|
|
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||
|
|
</body>
|
||
|
|
</html>
|