docs/classes/_reduxlocalstorage_.reduxlocalstorage.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ReduxLocalStorage | @weavedev/redux-local-storage - v0.1.0</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">@weavedev/redux-local-storage - v0.1.0</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="../modules/_reduxlocalstorage_.html">"ReduxLocalStorage"</a>
</li>
<li>
<a href="_reduxlocalstorage_.reduxlocalstorage.html">ReduxLocalStorage</a>
</li>
</ul>
<h1>Class ReduxLocalStorage<R, M></h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Typed redux local storage class that mirrors state to and from JavaScript's <code>window.localStorage</code>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>R<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Reduxable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
</li>
<li>
<h4>M</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">Reduxable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R["state"]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">R["actionMap"]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R["run"]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ReduxLocalStorage</span>
</li>
</ul>
</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_reduxlocalstorage_.reduxlocalstorage.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="_reduxlocalstorage_.reduxlocalstorage.html#actiontypemap" class="tsd-kind-icon">action<wbr>Type<wbr>Map</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_reduxlocalstorage_.reduxlocalstorage.html#reduxable" class="tsd-kind-icon">reduxable</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_reduxlocalstorage_.reduxlocalstorage.html#target" class="tsd-kind-icon">target</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_reduxlocalstorage_.reduxlocalstorage.html#transform" class="tsd-kind-icon">transform</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_reduxlocalstorage_.reduxlocalstorage.html#triggers" class="tsd-kind-icon">triggers</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite"><a href="_reduxlocalstorage_.reduxlocalstorage.html#actionmap" class="tsd-kind-icon">action<wbr>Map</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_reduxlocalstorage_.reduxlocalstorage.html#actions" class="tsd-kind-icon">actions</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite"><a href="_reduxlocalstorage_.reduxlocalstorage.html#defaultstate" class="tsd-kind-icon">default<wbr>State</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="_reduxlocalstorage_.reduxlocalstorage.html#internalreducer" class="tsd-kind-icon">internal<wbr>Reducer</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_reduxlocalstorage_.reduxlocalstorage.html#reducer" class="tsd-kind-icon">reducer</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite"><a href="_reduxlocalstorage_.reduxlocalstorage.html#runsaga" class="tsd-kind-icon">run<wbr>Saga</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite"><a href="_reduxlocalstorage_.reduxlocalstorage.html#saga" class="tsd-kind-icon">saga</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_reduxlocalstorage_.reduxlocalstorage.html#state" class="tsd-kind-icon">state</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-class tsd-is-overwrite"><a href="_reduxlocalstorage_.reduxlocalstorage.html#run" class="tsd-kind-icon">run</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Redux<wbr>Local<wbr>Storage<span class="tsd-signature-symbol">(</span>reduxable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">R</span>, target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_reduxlocalstorage_.reduxlocalstorageoptions.html" class="tsd-signature-type">ReduxLocalStorageOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">M</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_reduxlocalstorage_.reduxlocalstorage.html" class="tsd-signature-type">ReduxLocalStorage</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/redux-local-storage/blob/5b67e12/lib/ReduxLocalStorage.ts#L32">lib/ReduxLocalStorage.ts:32</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>reduxable: <span class="tsd-signature-type">R</span></h5>
</li>
<li>
<h5>target: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_reduxlocalstorage_.reduxlocalstorageoptions.html" class="tsd-signature-type">ReduxLocalStorageOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">M</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_reduxlocalstorage_.reduxlocalstorage.html" class="tsd-signature-type">ReduxLocalStorage</a></h4>
</li>
</ul>
</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-class tsd-is-overwrite">
<a name="actiontypemap" class="tsd-anchor"></a>
<h3>action<wbr>Type<wbr>Map</h3>
<div class="tsd-signature tsd-kind-icon">action<wbr>Type<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">R["actionTypeMap"]</span></div>
<aside class="tsd-sources">
<p>Overrides Reduxable.actionTypeMap</p>
<ul>
<li>Defined in <a href="https://github.com/gerarts/redux-local-storage/blob/5b67e12/lib/ReduxLocalStorage.ts#L27">lib/ReduxLocalStorage.ts:27</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="reduxable" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> reduxable</h3>
<div class="tsd-signature tsd-kind-icon">reduxable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">R</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/redux-local-storage/blob/5b67e12/lib/ReduxLocalStorage.ts#L29">lib/ReduxLocalStorage.ts:29</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="target" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> target</h3>
<div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/redux-local-storage/blob/5b67e12/lib/ReduxLocalStorage.ts#L30">lib/ReduxLocalStorage.ts:30</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="transform" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> transform</h3>
<div class="tsd-signature tsd-kind-icon">transform<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_reduxlocalstorage_.readwritetransformer.html" class="tsd-signature-type">ReadWriteTransformer</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R["state"]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">M</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/redux-local-storage/blob/5b67e12/lib/ReduxLocalStorage.ts#L31">lib/ReduxLocalStorage.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="triggers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagOptional">Optional</span> triggers</h3>
<div class="tsd-signature tsd-kind-icon">triggers<span class="tsd-signature-symbol">:</span> <a href="../modules/_reduxlocalstorage_.html#typesfromreduxable" class="tsd-signature-type">TypesFromReduxable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gerarts/redux-local-storage/blob/5b67e12/lib/ReduxLocalStorage.ts#L32">lib/ReduxLocalStorage.ts:32</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a name="actionmap" class="tsd-anchor"></a>
<h3>action<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> actionMap<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">R["actionMap"]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides Reduxable.actionMap</p>
<ul>
<li>Defined in <a href="https://github.com/gerarts/redux-local-storage/blob/5b67e12/lib/ReduxLocalStorage.ts#L47">lib/ReduxLocalStorage.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">R["actionMap"]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="actions" class="tsd-anchor"></a>
<h3>actions</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> actions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">R["actionMap"][keyof R["actionMap"]]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Reduxable.actions</p>
<ul>
<li>Defined in node_modules/@weavedev/reduxable/dist/Reduxable.d.ts:24</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">R["actionMap"][keyof R["actionMap"]]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a name="defaultstate" class="tsd-anchor"></a>
<h3>default<wbr>State</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> defaultState<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">R["state"]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides Reduxable.defaultState</p>
<ul>
<li>Defined in <a href="https://github.com/gerarts/redux-local-storage/blob/5b67e12/lib/ReduxLocalStorage.ts#L54">lib/ReduxLocalStorage.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Passthrough default state with marker added to identify defaultState in the reducer.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">R["state"]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<a name="internalreducer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> internal<wbr>Reducer</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> internalReducer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">InternalReducer</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R["state"]</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides Reduxable.internalReducer</p>
<ul>
<li>Defined in <a href="https://github.com/gerarts/redux-local-storage/blob/5b67e12/lib/ReduxLocalStorage.ts#L61">lib/ReduxLocalStorage.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">InternalReducer</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R["state"]</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="reducer" class="tsd-anchor"></a>
<h3>reducer</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> reducer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Reducer</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R["state"]</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Reduxable.reducer</p>
<ul>
<li>Defined in node_modules/@weavedev/reduxable/dist/Reduxable.d.ts:26</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Reducer</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R["state"]</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a name="runsaga" class="tsd-anchor"></a>
<h3>run<wbr>Saga</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> runSaga<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">R["runSaga"]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides Reduxable.runSaga</p>
<ul>
<li>Defined in <a href="https://github.com/gerarts/redux-local-storage/blob/5b67e12/lib/ReduxLocalStorage.ts#L126">lib/ReduxLocalStorage.ts:126</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">R["runSaga"]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a name="saga" class="tsd-anchor"></a>
<h3>saga</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> saga<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">R["saga"]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides Reduxable.saga</p>
<ul>
<li>Defined in <a href="https://github.com/gerarts/redux-local-storage/blob/5b67e12/lib/ReduxLocalStorage.ts#L116">lib/ReduxLocalStorage.ts:116</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">R["saga"]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="state" class="tsd-anchor"></a>
<h3>state</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> state<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">R["state"]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Reduxable.state</p>
<ul>
<li>Defined in node_modules/@weavedev/reduxable/dist/Reduxable.d.ts:27</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">R["state"]</span></h4>
</li>
</ul>
</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-class tsd-is-overwrite">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R["run"]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R["run"]</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides Reduxable.run</p>
<ul>
<li>Defined in <a href="https://github.com/gerarts/redux-local-storage/blob/5b67e12/lib/ReduxLocalStorage.ts#L121">lib/ReduxLocalStorage.ts:121</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>i: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R["run"]</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R["run"]</span><span class="tsd-signature-symbol">></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>
<li class="current tsd-kind-external-module">
<a href="../modules/_reduxlocalstorage_.html">"<wbr>Redux<wbr>Local<wbr>Storage"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_reduxlocalstorage_.reduxlocalstorage.html" class="tsd-kind-icon">Redux<wbr>Local<wbr>Storage</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#actiontypemap" class="tsd-kind-icon">action<wbr>Type<wbr>Map</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#reduxable" class="tsd-kind-icon">reduxable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#target" class="tsd-kind-icon">target</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#transform" class="tsd-kind-icon">transform</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#triggers" class="tsd-kind-icon">triggers</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#actionmap" class="tsd-kind-icon">action<wbr>Map</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#actions" class="tsd-kind-icon">actions</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#defaultstate" class="tsd-kind-icon">default<wbr>State</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#internalreducer" class="tsd-kind-icon">internal<wbr>Reducer</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#reducer" class="tsd-kind-icon">reducer</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#runsaga" class="tsd-kind-icon">run<wbr>Saga</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#saga" class="tsd-kind-icon">saga</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#state" class="tsd-kind-icon">state</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="_reduxlocalstorage_.reduxlocalstorage.html#run" class="tsd-kind-icon">run</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
<a href="../interfaces/_reduxlocalstorage_.readwritetransformer.html" class="tsd-kind-icon">Read<wbr>Write<wbr>Transformer</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
<a href="../interfaces/_reduxlocalstorage_.reduxlocalstorageoptions.html" class="tsd-kind-icon">Redux<wbr>Local<wbr>Storage<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
<a href="../modules/_reduxlocalstorage_.html#typefromreduxable" class="tsd-kind-icon">Type<wbr>From<wbr>Reduxable</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-not-exported">
<a href="../modules/_reduxlocalstorage_.html#typesfromreduxable" class="tsd-kind-icon">Types<wbr>From<wbr>Reduxable</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
<a href="../modules/_reduxlocalstorage_.html#defaultstatesourcemarker" class="tsd-kind-icon">default<wbr>State<wbr>Source<wbr>Marker</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>