@state-sync/js-client
Version:
401 lines • 20.9 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PatchAreaRequest | @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/_events_.html">"Events"</a>
</li>
<li>
<a href="_events_.patcharearequest.html">PatchAreaRequest</a>
</li>
</ul>
<h1>Class PatchAreaRequest</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>
<a href="_events_.requestmessage.html" class="tsd-signature-type">RequestMessage</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">PatchAreaRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/_events_.message.html" class="tsd-signature-type">Message</a></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 tsd-is-overwrite"><a href="_events_.patcharearequest.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"><a href="_events_.patcharearequest.html#area" class="tsd-kind-icon">area</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_events_.patcharearequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_events_.patcharearequest.html#patch" class="tsd-kind-icon">patch</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_events_.patcharearequest.html#type" class="tsd-kind-icon">type</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 tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Patch<wbr>Area<wbr>Request<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, area<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, patch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</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><span class="tsd-signature-symbol">: </span><a href="_events_.patcharearequest.html" class="tsd-signature-type">PatchAreaRequest</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="_events_.requestmessage.html">RequestMessage</a>.<a href="_events_.requestmessage.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/Events.ts#L92">Events.ts:92</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>area: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>patch: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_events_.patcharearequest.html" class="tsd-signature-type">PatchAreaRequest</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">
<a name="area" class="tsd-anchor"></a>
<h3>area</h3>
<div class="tsd-signature tsd-kind-icon">area<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/Events.ts#L91">Events.ts:91</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_events_.requestmessage.html">RequestMessage</a>.<a href="_events_.requestmessage.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/Events.ts#L32">Events.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Identifier of request in the scope of current session</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="patch" class="tsd-anchor"></a>
<h3>patch</h3>
<div class="tsd-signature tsd-kind-icon">patch<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/Events.ts#L92">Events.ts:92</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_events_.message.html">Message</a>.<a href="../interfaces/_events_.message.html#type">type</a></p>
<p>Inherited from <a href="_events_.requestmessage.html">RequestMessage</a>.<a href="_events_.requestmessage.html#type">type</a></p>
<ul>
<li>Defined in <a href="https://github.com/state-sync/state-sync-js-client/blob/1cda845/src/Events.ts#L28">Events.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See Message#type description</p>
</div>
</div>
</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="current 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=" 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="_events_.patcharearequest.html" class="tsd-kind-icon">Patch<wbr>Area<wbr>Request</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="_events_.patcharearequest.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_events_.patcharearequest.html#area" class="tsd-kind-icon">area</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_events_.patcharearequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_events_.patcharearequest.html#patch" class="tsd-kind-icon">patch</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_events_.patcharearequest.html#type" class="tsd-kind-icon">type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="_events_.requestmessage.html" class="tsd-kind-icon">Request<wbr>Message</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="_events_.rpcrequest.html" class="tsd-kind-icon">Rpc<wbr>Request</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="_events_.subscribearearequest.html" class="tsd-kind-icon">Subscribe<wbr>Area<wbr>Request</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="_events_.unsubscribearearequest.html" class="tsd-kind-icon">Unsubscribe<wbr>Area<wbr>Request</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_events_.eventmessage.html" class="tsd-kind-icon">Event<wbr>Message</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_events_.initsessionresponse.html" class="tsd-kind-icon">Init<wbr>Session<wbr>Response</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_events_.message.html" class="tsd-kind-icon">Message</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_events_.patchareaevent.html" class="tsd-kind-icon">Patch<wbr>Area<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_events_.patchareafail.html" class="tsd-kind-icon">Patch<wbr>Area<wbr>Fail</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_events_.patcharearesponse.html" class="tsd-kind-icon">Patch<wbr>Area<wbr>Response</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_events_.responsemessage.html" class="tsd-kind-icon">Response<wbr>Message</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_events_.subscribeareafail.html" class="tsd-kind-icon">Subscribe<wbr>Area<wbr>Fail</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_events_.subscribearearesponse.html" class="tsd-kind-icon">Subscribe<wbr>Area<wbr>Response</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_events_.unsubscribearearesponse.html" class="tsd-kind-icon">Unsubscribe<wbr>Area<wbr>Response</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_events_.html#incomingevents" class="tsd-kind-icon">Incoming<wbr>Events</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>
</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="http://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>