node-eventstore-client
Version:
A port of the EventStore .Net ClientAPI to Node.js
5,732 lines • 86 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: EventStoreNodeConnection</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: EventStoreNodeConnection</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature">(protected) </span></span>EventStoreNodeConnection<span class="signature">()</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="EventStoreNodeConnection"><span class="type-signature">(protected) </span>new EventStoreNodeConnection<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="appendToStream"><span class="type-signature"></span>appendToStream<span class="signature">(stream, expectedVersion, events, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="WriteResult.html">WriteResult</a>>}</span></h4>
<div class="description">
Append events to a stream (async)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">The name of the stream to which to append.</td>
</tr>
<tr>
<td class="name"><code>expectedVersion</code></td>
<td class="type">
<span class="param-type">Long</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The version at which we currently expect the stream to be in order that an optimistic concurrency check can be performed.</td>
</tr>
<tr>
<td class="name"><code>events</code></td>
<td class="type">
<span class="param-type">Array.<EventData></span>
|
<span class="param-type">EventData</span>
</td>
<td class="attributes">
</td>
<td class="description last">The event(s) to append.</td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">User credentials</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line139">line 139</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="WriteResult.html">WriteResult</a>></span>
</dd>
</dl>
<h4 class="name" id="close"><span class="type-signature"></span>close<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Close connection
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line97">line 97</a>
</li></ul></dd>
</dl>
<h4 class="name" id="commitTransaction"><span class="type-signature"></span>commitTransaction<span class="signature">(transaction, userCredentials)</span><span class="type-signature"> → {Promise.<<a href="WriteResult.html">WriteResult</a>>}</span></h4>
<div class="description">
Commit a transaction
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>transaction</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line222">line 222</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="WriteResult.html">WriteResult</a>></span>
</dd>
</dl>
<h4 class="name" id="connect"><span class="type-signature"></span>connect<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
Start connection task
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line81">line 81</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="connectToPersistentSubscription"><span class="type-signature"></span>connectToPersistentSubscription<span class="signature">(stream, groupName, eventAppeared, subscriptionDropped<span class="signature-attributes">opt</span>, userCredentials<span class="signature-attributes">opt</span>, bufferSize<span class="signature-attributes">opt</span>, autoAck<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<EventStorePersistentSubscription>}</span></h4>
<div class="description">
Subscribe to a persistent subscription
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>groupName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>eventAppeared</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>subscriptionDropped</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>bufferSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>autoAck</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line531">line 531</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<EventStorePersistentSubscription></span>
</dd>
</dl>
<h4 class="name" id="continueTransaction"><span class="type-signature"></span>continueTransaction<span class="signature">(transactionId, userCredentials)</span><span class="type-signature"> → {<a href="EventStoreTransaction.html">EventStoreTransaction</a>}</span></h4>
<div class="description">
Continue a transaction
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>transactionId</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line192">line 192</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="EventStoreTransaction.html">EventStoreTransaction</a></span>
</dd>
</dl>
<h4 class="name" id="createPersistentSubscription"><span class="type-signature"></span>createPersistentSubscription<span class="signature">(stream, groupName, settings, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="PersistentSubscriptionCreateResult.html">PersistentSubscriptionCreateResult</a>>}</span></h4>
<div class="description">
Create a persistent subscription
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>groupName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>settings</code></td>
<td class="type">
<span class="param-type">PersistentSubscriptionSettings</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line558">line 558</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="PersistentSubscriptionCreateResult.html">PersistentSubscriptionCreateResult</a>></span>
</dd>
</dl>
<h4 class="name" id="deletePersistentSubscription"><span class="type-signature"></span>deletePersistentSubscription<span class="signature">(stream, groupName, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="PersistentSubscriptionDeleteResult.html">PersistentSubscriptionDeleteResult</a>>}</span></h4>
<div class="description">
Delete a persistent subscription
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>groupName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line606">line 606</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="PersistentSubscriptionDeleteResult.html">PersistentSubscriptionDeleteResult</a>></span>
</dd>
</dl>
<h4 class="name" id="deleteStream"><span class="type-signature"></span>deleteStream<span class="signature">(stream, expectedVersion, hardDelete<span class="signature-attributes">opt</span>, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="DeleteResult.html">DeleteResult</a>>}</span></h4>
<div class="description">
Delete a stream (async)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>expectedVersion</code></td>
<td class="type">
<span class="param-type">Long</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>hardDelete</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line110">line 110</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="DeleteResult.html">DeleteResult</a>></span>
</dd>
</dl>
<h4 class="name" id="getStreamMetadataRaw"><span class="type-signature"></span>getStreamMetadataRaw<span class="signature">(stream, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="RawStreamMetadataResult.html">RawStreamMetadataResult</a>>}</span></h4>
<div class="description">
Get stream metadata as raw object (async)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line680">line 680</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="RawStreamMetadataResult.html">RawStreamMetadataResult</a>></span>
</dd>
</dl>
<h4 class="name" id="readAllEventsBackward"><span class="type-signature"></span>readAllEventsBackward<span class="signature">(position, maxCount, resolveLinkTos<span class="signature-attributes">opt</span>, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="AllEventsSlice.html">AllEventsSlice</a>>}</span></h4>
<div class="description">
Reading all events backwards (async)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type"><a href="Position.html">Position</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>maxCount</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>resolveLinkTos</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line378">line 378</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="AllEventsSlice.html">AllEventsSlice</a>></span>
</dd>
</dl>
<h4 class="name" id="readAllEventsForward"><span class="type-signature"></span>readAllEventsForward<span class="signature">(position, maxCount, resolveLinkTos<span class="signature-attributes">opt</span>, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="AllEventsSlice.html">AllEventsSlice</a>>}</span></h4>
<div class="description">
Reading all events forwards (async)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type"><a href="Position.html">Position</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>maxCount</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>resolveLinkTos</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line347">line 347</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="AllEventsSlice.html">AllEventsSlice</a>></span>
</dd>
</dl>
<h4 class="name" id="readEvent"><span class="type-signature"></span>readEvent<span class="signature">(stream, eventNumber, resolveLinkTos<span class="signature-attributes">opt</span>, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="EventReadResult.html">EventReadResult</a>>}</span></h4>
<div class="description">
Read a single event (async)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>eventNumber</code></td>
<td class="type">
<span class="param-type">Long</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>resolveLinkTos</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line246">line 246</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="EventReadResult.html">EventReadResult</a>></span>
</dd>
</dl>
<h4 class="name" id="readStreamEventsBackward"><span class="type-signature"></span>readStreamEventsBackward<span class="signature">(stream, start, count, resolveLinkTos<span class="signature-attributes">opt</span>, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="StreamEventsSlice.html">StreamEventsSlice</a>>}</span></h4>
<div class="description">
Reading a specific stream backwards (async)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>start</code></td>
<td class="type">
<span class="param-type">Long</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>count</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>resolveLinkTos</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line314">line 314</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="StreamEventsSlice.html">StreamEventsSlice</a>></span>
</dd>
</dl>
<h4 class="name" id="readStreamEventsForward"><span class="type-signature"></span>readStreamEventsForward<span class="signature">(stream, start, count, resolveLinkTos<span class="signature-attributes">opt</span>, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="StreamEventsSlice.html">StreamEventsSlice</a>>}</span></h4>
<div class="description">
Reading a specific stream forwards (async)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>start</code></td>
<td class="type">
<span class="param-type">Long</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>count</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>resolveLinkTos</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line279">line 279</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="StreamEventsSlice.html">StreamEventsSlice</a>></span>
</dd>
</dl>
<h4 class="name" id="setStreamMetadataRaw"><span class="type-signature"></span>setStreamMetadataRaw<span class="signature">(stream, expectedMetastreamVersion, metadata, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="WriteResult.html">WriteResult</a>>}</span></h4>
<div class="description">
Set stream metadata with raw object (async)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>expectedMetastreamVersion</code></td>
<td class="type">
<span class="param-type">Long</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>metadata</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line638">line 638</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="WriteResult.html">WriteResult</a>></span>
</dd>
</dl>
<h4 class="name" id="startTransaction"><span class="type-signature"></span>startTransaction<span class="signature">(stream, expectedVersion, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="EventStoreTransaction.html">EventStoreTransaction</a>>}</span></h4>
<div class="description">
Start a transaction (async)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>expectedVersion</code></td>
<td class="type">
<span class="param-type">Long</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line167">line 167</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="EventStoreTransaction.html">EventStoreTransaction</a>></span>
</dd>
</dl>
<h4 class="name" id="subscribeToAll"><span class="type-signature"></span>subscribeToAll<span class="signature">(resolveLinkTos<span class="signature-attributes">non-null</span>, eventAppeared<span class="signature-attributes">non-null</span>, subscriptionDropped<span class="signature-attributes">opt</span>, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="EventStoreSubscription.html">EventStoreSubscription</a>>}</span></h4>
<div class="description">
Subscribe to all (async)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>resolveLinkTos</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>eventAppeared</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>subscriptionDropped</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line472">line 472</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="EventStoreSubscription.html">EventStoreSubscription</a>></span>
</dd>
</dl>
<h4 class="name" id="subscribeToAllFrom"><span class="type-signature"></span>subscribeToAllFrom<span class="signature">(lastCheckpoint<span class="signature-attributes">nullable</span>, resolveLinkTos<span class="signature-attributes">non-null</span>, eventAppeared<span class="signature-attributes">non-null</span>, liveProcessingStarted<span class="signature-attributes">opt</span>, subscriptionDropped<span class="signature-attributes">opt</span>, userCredentials<span class="signature-attributes">opt</span>, readBatchSize<span class="signature-attributes">opt, non-null</span>)</span><span class="type-signature"> → {EventStoreAllCatchUpSubscription}</span></h4>
<div class="description">
Subscribe to all from
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>lastCheckpoint</code></td>
<td class="type">
<span class="param-type"><a href="Position.html">Position</a></span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>resolveLinkTos</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>eventAppeared</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>liveProcessingStarted</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>subscriptionDropped</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>readBatchSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line502">line 502</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">EventStoreAllCatchUpSubscription</span>
</dd>
</dl>
<h4 class="name" id="subscribeToStream"><span class="type-signature"></span>subscribeToStream<span class="signature">(stream<span class="signature-attributes">non-null</span>, resolveLinkTos<span class="signature-attributes">non-null</span>, eventAppeared, subscriptionDropped<span class="signature-attributes">opt</span>, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="EventStoreSubscription.html">EventStoreSubscription</a>>}</span></h4>
<div class="description">
Subscribe to a stream (async)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>resolveLinkTos</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>eventAppeared</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>subscriptionDropped</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line410">line 410</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="EventStoreSubscription.html">EventStoreSubscription</a>></span>
</dd>
</dl>
<h4 class="name" id="subscribeToStreamFrom"><span class="type-signature"></span>subscribeToStreamFrom<span class="signature">(stream<span class="signature-attributes">non-null</span>, lastCheckpoint, resolveLinkTos<span class="signature-attributes">non-null</span>, eventAppeared<span class="signature-attributes">non-null</span>, liveProcessingStarted<span class="signature-attributes">opt</span>, subscriptionDropped<span class="signature-attributes">opt</span>, userCredentials<span class="signature-attributes">opt</span>, readBatchSize<span class="signature-attributes">opt, non-null</span>)</span><span class="type-signature"> → {EventStoreStreamCatchUpSubscription}</span></h4>
<div class="description">
Subscribe to a stream from position
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>lastCheckpoint</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type"><a href="Position.html">Position</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>resolveLinkTos</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>eventAppeared</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>liveProcessingStarted</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>subscriptionDropped</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>readBatchSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line443">line 443</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">EventStoreStreamCatchUpSubscription</span>
</dd>
</dl>
<h4 class="name" id="updatePersistentSubscription"><span class="type-signature"></span>updatePersistentSubscription<span class="signature">(stream, groupName, settings, userCredentials<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="PersistentSubscriptionUpdateResult.html">PersistentSubscriptionUpdateResult</a>>}</span></h4>
<div class="description">
Update a persistent subscription
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stream</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>groupName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>settings</code></td>
<td class="type">
<span class="param-type">PersistentSubscriptionSettings</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>userCredentials</code></td>
<td class="type">
<span class="param-type"><a href="UserCredentials.html">UserCredentials</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="eventStoreNodeConnection.js.html">eventStoreNodeConnection.js</a>, <a href="eventStoreNodeConnection.js.html#line583">line 583</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="PersistentSubscriptionUpdateResult.html">PersistentSubscriptionUpdateResult</a>></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="EventStore.html">EventStore</a></li><li><a href="EventStore.Client.html">Client</a></li><li><a href="EventStore.Client.Messages.html">Messages</a></li></ul><h3>Classes</h3><ul><li><a href="AllEventsSlice.html">AllEventsSlice</a></li><li><a href="ClusterDiscoverer.html">ClusterDiscoverer</a></li><li><a href="DeleteResult.html">DeleteResult</a></li><li><a href="EventReadResult.html">EventReadResult</a></li><li><a href="EventStore.Client.Messages.CheckpointReached.html">CheckpointReached</a></li><li><a href="EventStore.Client.Messages.ClientIdentified.html">ClientIdentified</a></li><li><a href="EventStore.Client.Messages.ConnectToPersistentSubscription.html">ConnectToPersistentSubscription</a></li><li><a href="EventStore.Client.Messages.CreatePersistentSubscription.html">CreatePersistentSubscription</a></li><li><a href="EventStore.Client.Messages.CreatePersistentSubscriptionCompleted.html">CreatePersistentSubscriptionCompleted</a></li><li><a href="EventStore.Client.Messages.DeletePersistentSubscription.html">DeletePersistentSubscription</a></li><li><a href="EventStore.Client.Messages.DeletePersistentSubscriptionCompleted.html">DeletePersistentSubscriptionCompleted</a></li><li><a href="EventStore.Client.Messages.DeleteStream.html">DeleteStream</a></li><li><a href="EventStore.Client.Messages.DeleteStreamCompleted.html">DeleteStreamCompleted</a></li><li><a href="EventStore.Client.Messages.EventRecord.html">EventRecord</a></li><li><a href="EventStore.Client.Messages.Filter.html">Filter</a></li><li><a href="EventStore.Client.Messages.FilteredReadAllEvents.html">FilteredReadAllEvents</a></li><li><a href="EventStore.Client.Messages.FilteredReadAllEventsCompleted.html">FilteredReadAllEventsCompleted</a></li><li><a href="EventStore.Client.Messages.FilteredSubscribeToStream.html">FilteredSubscribeToStream</a></li><li><a href="EventStore.Client.Messages.IdentifyClient.html">IdentifyClient</a></li><li><a href="EventStore.Client.Messages.NewEvent.html">NewEvent</a></li><li><a href="EventStore.Client.Messages.NotHandled.html">NotHandled</a></li><li><a href="EventStore.Client.Messages.NotHandled.LeaderInfo.html">LeaderInfo</a></li><li><a href="EventStore.Client.Messages.PersistentSubscriptionAckEvents.html">PersistentSubscriptionAckEvents</a></li><li><a href="EventStore.Client.Messages.PersistentSubscriptionConfirmation.html">PersistentSubscriptionConfirmation</a></li><li><a href="EventStore.Client.Messages.PersistentSubscriptionNakEvents.html">PersistentSubscriptionNakEvents</a></li><li><a href="EventStore.Client.Messages.PersistentSubscriptionStreamEventAppeared.html">PersistentSubscriptionStreamEventAppeared</a></li><li><a href="EventStore.Client.Messages.ReadAllEvents.html">ReadAllEvents</a></li><li><a href="EventStore.Client.Messages.ReadAllEventsCompleted.html">ReadAllEventsCompleted</a></li><li><a href="EventStore.Client.Messages.ReadEvent.html">ReadEvent</a></li><li><a href="EventStore.Client.Messages.ReadEventCompleted.html">ReadEventCompleted</a></li><li><a href="EventStore.Client.Messages.ReadStreamEvents.html">ReadStreamEvents</a></li><li><a href="EventStore.Client.Messages.ReadStreamEventsCompleted.html">ReadStreamEventsCompleted</a></li><li><a href="EventStore.Client.Messages.ResolvedEvent.html">ResolvedEvent</a></li><li><a href="EventStore.Client.Messages.ResolvedIndexedEvent.html">ResolvedIndexedEvent</a></li><li><a href="EventStore.Client.Messages.ScavengeDatabase.html">ScavengeDatabase</a></li><li><a href="EventStore.Client.Messages.ScavengeDatabaseResponse.html">ScavengeDatabaseResponse</a></li><li><a href="EventStore.Client.Messages.StreamEventAppeared.html">StreamEventAppeared</a></li><li><a href="EventStore.Client.Messages.SubscribeToStream.html">SubscribeToStream</a></li><li><a href="EventStore.Client.Messages.SubscriptionConfirmation.html">SubscriptionConfirmation</a></li><li><a href="EventStore.Client.Messages.SubscriptionDropped.html">SubscriptionDropped</a></li><li><a href="EventStore.Client.Messages.TransactionCommit.html">TransactionCommit</a></li><li><a href="EventStore.Client.Messages.TransactionCommitCompleted.html">TransactionCommitCompleted</a></li><li><a href="EventStore.Client.Messages.TransactionStart.html">TransactionStart</a></li><li><a href="EventStore.Client.Messages.TransactionStartCompleted.html">TransactionStartCompleted</a></li><li><a href="EventStore.Client.Messages.TransactionWrite.html">TransactionWrite</a></li><li><a href="EventStore.Client.Messages.TransactionWriteCompleted.html">TransactionWriteCompleted</a></li><li><a href="EventStore.Client.Messages.UnsubscribeFromStream.html">UnsubscribeFromStream</a></li><li><a href="EventStore.Client.Messages.UpdatePersistentSubscription.html">UpdatePersistentSubscription</a></li><li><a href="EventStore.Client.Messages.UpdatePersistentSubscriptionCompleted.html">UpdatePersistentSubscriptionCompleted</a></li><li><a href="EventStore.Client.Messages.WriteEvents.html">WriteEvents</a></li><li><a href="EventStore.Client.Messages.WriteEventsCompleted.html">WriteEventsCompleted</a></li><li><a href="EventStoreCatchUpSubscription.html">EventStoreCatchUpSubscription</a></li><li><a href="EventStoreNodeConnection.html">EventStoreNodeConnection</a></li><li><a href="EventStoreTransaction.html">EventStoreTransaction</a></li><li><a href="PersistentSubscriptionCreateResult.html">PersistentSubscriptionCreateResult</a></li><li><a href="PersistentSubscriptionDeleteResult.html">PersistentSubscriptionDeleteResult</a></li><li><a href="PersistentSubscriptionUpdateResult.html">PersistentSubscriptionUpdateResult</a></li><li><a href="Position.html">Position</a></li><li><a href="ProjectionsManager.html">ProjectionsManager</a></li><li><a href="RawStreamMetadataResult.html">RawStreamMetadataResult</a></li><li><a href="RecordedEvent.html">RecordedEvent</a></li><li><a href="ResolvedEvent.html">ResolvedEvent</a></li><li><a href="StreamEventsSlice.html">StreamEventsSlice</a></li><li><a href="UserCredentials.html">UserCredentials</a></li><li><a href="WriteResult.html">WriteResult</a></li></ul><h3>Interfaces</h3><ul><li><a href="EventStore.Client.Messages.ICheckpointReached.html">ICheckpointReached</a></li><li><a href="EventStore.Client.Messages.IClientIdentified.html">IClientIdentified</a></li><li><a href="EventStore.Client.Messages.IConnectToPersistentSubscription.html">IConnectToPersistentSubscription</a></li><li><a href="EventStore.Client.Messages.ICreatePersistentSubscription.html">ICreatePersistentSubscription</a></li><li><a href="EventStore.Client.Messages.ICreatePersistentSubscriptionCompleted.html">ICreatePersistentSubscriptionCompleted</a></li><li><a href="EventStore.Client.Messages.IDeletePersistentSubscription.html">IDeletePersistentSubscription</a></li><li><a href="EventStore.Client.Messages.IDeletePersistentSubscriptionCompleted.html">IDeletePersistentSubscriptionCompleted</a></li><li><a href="EventStore.Client.Messages.IDeleteStream.html">IDeleteStream</a></li><li><a href="EventStore.Client.Messages.IDeleteStreamCompleted.html">IDeleteStreamCompleted</a></li><li><a href="EventStore.Client.Messages.IEventRecord.html">IEventRecord</a></li><li><a href="EventStore.Client.Messages.IFilter.html">IFilter</a></li><li><a href="EventStore.Client.Messages.IFilteredReadAllEvents.html">IFilteredReadAllEvents</a></li><li><a href="EventStore.Client.Messages.IFilteredReadAllEventsCompleted.html">IFilteredReadAllEventsCompleted</a></li><li><a href="EventStore.Client.Messages.IFilteredSubscribeToStream.html">IFilteredSubscribeToStream</a></li><li><a href="EventStore.Client.Messages.IIdentifyClient.html">IIdentifyClient</a></li><li><a href="EventStore.Client.Messages.INewEvent.html">INewEvent</a></li><li><a href="EventStore.Client.Messages.INotHandled.html">INotHandled</a></li><li><a href="EventStore.Client.Messages.IPersistentSubscriptionAckEvents.html">IPersistentSubscriptionAckEvents</a></li><li><a href="EventStore.Client.Messages.IPersistentSubscriptionConfirmation.html">IPersistentSubscriptionConfirmation</a></li><li><a href="EventStore.Client.Messages.IPersistentSubscriptionNakEvents.html">IPersistentSubscriptionNakEvents</a></li><li><a href="EventStore.Client.Messages.IPersistentSubscriptionStreamEventAppeared.html">IPersistentSubscriptionStreamEventAppeared</a></li><li><a href="EventStore.Client.Messages.IReadAllEvents.html">IReadAllEvents</a></li><li><a href="EventStore.Client.Messages.IReadAllEventsCompleted.html">IReadAllEventsCompleted</a></li><li><a href="EventStore.Client.Messages.IReadEvent.html">IReadEvent</a></li><li><a href="EventStore.Client.Messages.IReadEventCompleted.html">IReadEventCompleted</a></li><li><a href="EventStore.Client.Messages.IReadStreamEvents.html">IReadStreamEvents</a></li><li><a href="EventStore.Client.Messages.IReadStreamEventsCompleted.html">IReadStreamEventsCompleted</a></li><li><a href="EventStore.Client.Messages.IResolvedEvent.html">IResolvedEvent</a></li><li><a href="EventStore.Client.Messages.IResolvedIndexedEvent.html">IResolvedIndexedEvent</a></li><li><a href="EventStore.Client.Messages.IScavengeDatabase.html">IScavengeDatabase</a></li><li><a href="EventStore.Client.Messages.IScavengeDatabaseResponse.html">IScavengeDatabaseResponse</a></li><li><a href="EventStore.Client.Messages.IStreamEventAppeared.html">IStreamEventAppeared</a></li><li><a href="EventStore.Client.Messages.ISubscribeToStream.html">ISubscribeToStream</a></li><li><a href="EventStore.Client.Messages.ISubscriptionConfirmation.html">ISubscriptionConfirmation</a></li><li><a href="EventStore.Client.Messages.ISubscriptionDropped.html">ISubscriptionDropped</a></li><li><a href="EventStore.Client.Messages.ITransactionCommit.html">ITransactionCommit</a></li><li><a href="EventStore.Client.Messages.ITransactionCommitCompleted.html">ITransactionCommitCompleted</a></li><li><a href="EventStore.Client.Messages.ITransactionStart.html">ITransactionStart</a></li><li><a href="EventStore.Client.Messages.ITransactionStartCompleted.html">ITransactionStartCompleted</a></li><li><a href="EventStore.Client.Messages.ITransactionWrite.html">ITransactionWrite</a></li><li><a href="EventStore.Client.Messages.ITransactionWriteCompleted.html">ITransactionWriteCompleted</a></li><li><a href="EventStore.Client.Messages.IUnsubscribeFromStream.html">IUnsubscribeFromStream</a></li><li><a href="EventStore.Client.Messages.IUpdatePersistentSubscription.html">IUpdatePersistentSubscription</a></li><li><a href="EventStore.Client.Messages.IUpdatePersistentSubscriptionCompleted.html">IUpdatePersistentSubscriptionCompleted</a></li><li><a href="EventStore.Client.Messages.IWriteEvents.html">IWriteEvents</a></li><li><a href="EventStore.Client.Messages.IWriteEventsCompleted.html">IWriteEventsCompleted</a></li><li><a href="EventStore.Client.Messages.NotHandled.ILeaderInfo.html">ILeaderInfo</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createConnection">createConnection</a></li><li><a href="global.html#createEventData">createEventData</a></li><li><a href="global.html#createJsonEventData">createJsonEventData</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Wed Jan 22 2025 20:03:13 GMT-0500 (Eastern Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>