UNPKG

@state-sync/js-client

Version:
876 lines 52.9 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>SyncArea | @state-sync/js-client</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">@state-sync/js-client</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/_syncarea_.html">&quot;SyncArea&quot;</a> </li> <li> <a href="_syncarea_.syncarea.html">SyncArea</a> </li> </ul> <h1>Class SyncArea</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">SyncArea</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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_syncarea_.syncarea.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-private"><a href="_syncarea_.syncarea.html#config" class="tsd-kind-icon">config</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_syncarea_.syncarea.html#helper" class="tsd-kind-icon">helper</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_syncarea_.syncarea.html#initialstate" class="tsd-kind-icon">initial<wbr>State</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_syncarea_.syncarea.html#lasthandledrequest" class="tsd-kind-icon">last<wbr>Handled<wbr>Request</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#lastrequestid" class="tsd-kind-icon">last<wbr>Request<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_syncarea_.syncarea.html#local" class="tsd-kind-icon">local</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#name" class="tsd-kind-icon">name</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_syncarea_.syncarea.html#patchqueue" class="tsd-kind-icon">patch<wbr>Queue</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_syncarea_.syncarea.html#promises" class="tsd-kind-icon">promises</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_syncarea_.syncarea.html#shadow" class="tsd-kind-icon">shadow</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_syncarea_.syncarea.html#subscribed" class="tsd-kind-icon">subscribed</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_syncarea_.syncarea.html#subscriptionscount" class="tsd-kind-icon">subscriptions<wbr>Count</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"><a href="_syncarea_.syncarea.html#actionreplace" class="tsd-kind-icon">action<wbr>Replace</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#actiontoggle" class="tsd-kind-icon">action<wbr>Toggle</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_syncarea_.syncarea.html#detectchanges" class="tsd-kind-icon">detect<wbr>Changes</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#dispatchsyncpatch" class="tsd-kind-icon">dispatch<wbr>Sync<wbr>Patch</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#init" class="tsd-kind-icon">init</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#onpatchareaerror" class="tsd-kind-icon">on<wbr>Patch<wbr>Area<wbr>Error</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#onpatchresponse" class="tsd-kind-icon">on<wbr>Patch<wbr>Response</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#onready" class="tsd-kind-icon">on<wbr>Ready</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#onserverpatch" class="tsd-kind-icon">on<wbr>Server<wbr>Patch</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#onsubscribe" class="tsd-kind-icon">on<wbr>Subscribe</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#onsubscribeerror" class="tsd-kind-icon">on<wbr>Subscribe<wbr>Error</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#onunsubscribe" class="tsd-kind-icon">on<wbr>Unsubscribe</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_syncarea_.syncarea.html#reduce" class="tsd-kind-icon">reduce</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#remote" class="tsd-kind-icon">remote</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#subscribe" class="tsd-kind-icon">subscribe</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_syncarea_.syncarea.html#wrap" class="tsd-kind-icon">wrap</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>Sync<wbr>Area<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, initialState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, helper<span class="tsd-signature-symbol">: </span><a href="../interfaces/_syncareahelper_.syncareahelper.html" class="tsd-signature-type">SyncAreaHelper</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_syncarea_.syncarea.html" class="tsd-signature-type">SyncArea</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L37">SyncArea.ts:37</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>initialState: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>helper: <a href="../interfaces/_syncareahelper_.syncareahelper.html" class="tsd-signature-type">SyncAreaHelper</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_syncarea_.syncarea.html" class="tsd-signature-type">SyncArea</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-private"> <a name="config" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> config</h3> <div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <a href="_syncareaconfig_.syncareaconfig.html" class="tsd-signature-type">SyncAreaConfig</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L30">SyncArea.ts:30</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Configuration retrieved from server in a process of subscription</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="helper" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> helper</h3> <div class="tsd-signature tsd-kind-icon">helper<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_syncareahelper_.syncareahelper.html" class="tsd-signature-type">SyncAreaHelper</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L23">SyncArea.ts:23</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="initialstate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> initial<wbr>State</h3> <div class="tsd-signature tsd-kind-icon">initial<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L32">SyncArea.ts:32</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="lasthandledrequest" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> last<wbr>Handled<wbr>Request</h3> <div class="tsd-signature tsd-kind-icon">last<wbr>Handled<wbr>Request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L34">SyncArea.ts:34</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="lastrequestid" class="tsd-anchor"></a> <h3>last<wbr>Request<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">last<wbr>Request<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L22">SyncArea.ts:22</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="local" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> local</h3> <div class="tsd-signature tsd-kind-icon">local<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L36">SyncArea.ts:36</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="name" class="tsd-anchor"></a> <h3>name</h3> <div class="tsd-signature tsd-kind-icon">name<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/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L24">SyncArea.ts:24</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="patchqueue" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> patch<wbr>Queue</h3> <div class="tsd-signature tsd-kind-icon">patch<wbr>Queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_events_.patchareaevent.html" class="tsd-signature-type">PatchAreaEvent</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> =&nbsp;[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L35">SyncArea.ts:35</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="promises" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> promises</h3> <div class="tsd-signature tsd-kind-icon">promises<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L37">SyncArea.ts:37</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>p: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="shadow" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> shadow</h3> <div class="tsd-signature tsd-kind-icon">shadow<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L31">SyncArea.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="subscribed" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> subscribed</h3> <div class="tsd-signature tsd-kind-icon">subscribed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L33">SyncArea.ts:33</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="subscriptionscount" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> subscriptions<wbr>Count</h3> <div class="tsd-signature tsd-kind-icon">subscriptions<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L26">SyncArea.ts:26</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-class"> <a name="actionreplace" class="tsd-anchor"></a> <h3>action<wbr>Replace</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">action<wbr>Replace<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<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><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L127">SyncArea.ts:127</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>value: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="actiontoggle" class="tsd-anchor"></a> <h3>action<wbr>Toggle</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">action<wbr>Toggle<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L135">SyncArea.ts:135</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="detectchanges" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> detect<wbr>Changes</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">detect<wbr>Changes<span class="tsd-signature-symbol">(</span>from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, to<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><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L175">SyncArea.ts:175</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>from: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>to: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="dispatchsyncpatch" class="tsd-anchor"></a> <h3>dispatch<wbr>Sync<wbr>Patch</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">dispatch<wbr>Sync<wbr>Patch<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="../interfaces/_events_.patchareaevent.html" class="tsd-signature-type">PatchAreaEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L103">SyncArea.ts:103</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <a href="../interfaces/_events_.patchareaevent.html" class="tsd-signature-type">PatchAreaEvent</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="init" class="tsd-anchor"></a> <h3>init</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L46">SyncArea.ts:46</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="onpatchareaerror" class="tsd-anchor"></a> <h3>on<wbr>Patch<wbr>Area<wbr>Error</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">on<wbr>Patch<wbr>Area<wbr>Error<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="../interfaces/_events_.patchareafail.html" class="tsd-signature-type">PatchAreaFail</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L119">SyncArea.ts:119</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <a href="../interfaces/_events_.patchareafail.html" class="tsd-signature-type">PatchAreaFail</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="onpatchresponse" class="tsd-anchor"></a> <h3>on<wbr>Patch<wbr>Response</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">on<wbr>Patch<wbr>Response<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="../interfaces/_events_.patcharearesponse.html" class="tsd-signature-type">PatchAreaResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L107">SyncArea.ts:107</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <a href="../interfaces/_events_.patcharearesponse.html" class="tsd-signature-type">PatchAreaResponse</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="onready" class="tsd-anchor"></a> <h3>on<wbr>Ready</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">on<wbr>Ready<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L54">SyncArea.ts:54</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="onserverpatch" class="tsd-anchor"></a> <h3>on<wbr>Server<wbr>Patch</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">on<wbr>Server<wbr>Patch<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="../interfaces/_events_.patchareaevent.html" class="tsd-signature-type">PatchAreaEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L115">SyncArea.ts:115</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <a href="../interfaces/_events_.patchareaevent.html" class="tsd-signature-type">PatchAreaEvent</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="onsubscribe" class="tsd-anchor"></a> <h3>on<wbr>Subscribe</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">on<wbr>Subscribe<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="../interfaces/_events_.subscribearearesponse.html" class="tsd-signature-type">SubscribeAreaResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L92">SyncArea.ts:92</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <a href="../interfaces/_events_.subscribearearesponse.html" class="tsd-signature-type">SubscribeAreaResponse</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="onsubscribeerror" class="tsd-anchor"></a> <h3>on<wbr>Subscribe<wbr>Error</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">on<wbr>Subscribe<wbr>Error<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="../interfaces/_events_.subscribeareafail.html" class="tsd-signature-type">SubscribeAreaFail</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L123">SyncArea.ts:123</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <a href="../interfaces/_events_.subscribeareafail.html" class="tsd-signature-type">SubscribeAreaFail</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="onunsubscribe" class="tsd-anchor"></a> <h3>on<wbr>Unsubscribe</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">on<wbr>Unsubscribe<span class="tsd-signature-symbol">(</span>_event<span class="tsd-signature-symbol">: </span><a href="../interfaces/_events_.unsubscribearearesponse.html" class="tsd-signature-type">UnsubscribeAreaResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L98">SyncArea.ts:98</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>_event: <a href="../interfaces/_events_.unsubscribearearesponse.html" class="tsd-signature-type">UnsubscribeAreaResponse</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="reduce" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> reduce</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">reduce<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, ext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, reducer<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><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/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L146">SyncArea.ts:146</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>state: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>action: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>ext: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>reducer: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="remote" class="tsd-anchor"></a> <h3>remote</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">remote<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, parameters<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L76">SyncArea.ts:76</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>command: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>parameters: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="subscribe" class="tsd-anchor"></a> <h3>subscribe</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">subscribe<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L58">SyncArea.ts:58</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="unsubscribe" class="tsd-anchor"></a> <h3>unsubscribe</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">unsubscribe<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L67">SyncArea.ts:67</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="wrap" class="tsd-anchor"></a> <h3>wrap</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">wrap<span class="tsd-signature-symbol">(</span>reducer<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><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/state-sync/state-sync-js-client/blob/1cda845/src/SyncArea.ts#L50">SyncArea.ts:50</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>reducer: <span class="tsd-signature-type">any</span></h5> </li> </ul> <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> <li class=" tsd-kind-external-module"> <a href="../modules/_abstractstore_.html">"<wbr>Abstract<wbr>Store"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_events_.html">"<wbr>Events"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_iconnectionstatuslistener_.html">"IConnection<wbr>Status<wbr>Listener"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_ieventlistener_.html">"IEvent<wbr>Listener"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_isyncservice_.html">"ISync<wbr>Service"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_statesyncstatusreducer_.html">"<wbr>State<wbr>Sync<wbr>Status<wbr>Reducer"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_stompconnection_.html">"<wbr>Stomp<wbr>Connection"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_syncactions_.html">"<wbr>Sync<wbr>Actions"</a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_syncarea_.html">"<wbr>Sync<wbr>Area"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_syncareaconfig_.html">"<wbr>Sync<wbr>Area<wbr>Config"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_syncareahelper_.html">"<wbr>Sync<wbr>Area<wbr>Helper"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_syncarearegistry_.html">"<wbr>Sync<wbr>Area<wbr>Registry"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_syncconfig_.html">"<wbr>Sync<wbr>Config"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_syncservice_.html">"<wbr>Sync<wbr>Service"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_index_.html">"index"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_utils_find_.html">"utils/find"</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"> <a href="_syncarea_.syncarea.html" class="tsd-kind-icon">Sync<wbr>Area</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_syncarea_.syncarea.html#config" class="tsd-kind-icon">config</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_syncarea_.syncarea.html#helper" class="tsd-kind-icon">helper</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_syncarea_.syncarea.html#initialstate" class="tsd-kind-icon">initial<wbr>State</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_syncarea_.syncarea.html#lasthandledrequest" class="tsd-kind-icon">last<wbr>Handled<wbr>Request</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#lastrequestid" class="tsd-kind-icon">last<wbr>Request<wbr>Id</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_syncarea_.syncarea.html#local" class="tsd-kind-icon">local</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#name" class="tsd-kind-icon">name</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_syncarea_.syncarea.html#patchqueue" class="tsd-kind-icon">patch<wbr>Queue</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_syncarea_.syncarea.html#promises" class="tsd-kind-icon">promises</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_syncarea_.syncarea.html#shadow" class="tsd-kind-icon">shadow</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_syncarea_.syncarea.html#subscribed" class="tsd-kind-icon">subscribed</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_syncarea_.syncarea.html#subscriptionscount" class="tsd-kind-icon">subscriptions<wbr>Count</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#actionreplace" class="tsd-kind-icon">action<wbr>Replace</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#actiontoggle" class="tsd-kind-icon">action<wbr>Toggle</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="_syncarea_.syncarea.html#detectchanges" class="tsd-kind-icon">detect<wbr>Changes</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#dispatchsyncpatch" class="tsd-kind-icon">dispatch<wbr>Sync<wbr>Patch</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#init" class="tsd-kind-icon">init</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#onpatchareaerror" class="tsd-kind-icon">on<wbr>Patch<wbr>Area<wbr>Error</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#onpatchresponse" class="tsd-kind-icon">on<wbr>Patch<wbr>Response</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#onready" class="tsd-kind-icon">on<wbr>Ready</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#onserverpatch" class="tsd-kind-icon">on<wbr>Server<wbr>Patch</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#onsubscribe" class="tsd-kind-icon">on<wbr>Subscribe</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#onsubscribeerror" class="tsd-kind-icon">on<wbr>Subscribe<wbr>Error</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#onunsubscribe" class="tsd-kind-icon">on<wbr>Unsubscribe</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="_syncarea_.syncarea.html#reduce" class="tsd-kind-icon">reduce</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#remote" class="tsd-kind-icon">remote</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#subscribe" class="tsd-kind-icon">subscribe</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_syncarea_.syncarea.html#wrap" class="tsd-kind-icon">wrap</a> </li> </ul> </li> </ul> <ul class="after-current"> </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> </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 s