node-eventstore-client

<!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>  <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> <tab