node-eventstore-client

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: UpdatePersistentSubscription</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: UpdatePersistentSubscription</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span> <span class="ancestors"><a href="EventStore.html">EventStore</a><a href="EventStore.Client.html">.Client</a><a href="EventStore.Client.Messages.html">.Messages</a>.</span>UpdatePersistentSubscription<span class="signature">(properties<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> <div class="class-description">Represents an UpdatePersistentSubscription.</div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="UpdatePersistentSubscription"><span class="type-signature"></span>new UpdatePersistentSubscription<span class="signature">(properties<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Constructs a new UpdatePersistentSubscription. </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>properties</code></td> <td class="type"> <span class="param-type"><a href="EventStore.Client.Messages.IUpdatePersistentSubscription.html">EventStore.Client.Messages.IUpdatePersistentSubscription</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Properties to set</td> </tr> </tbody> </table> <dl class="details"> <dt class="implements">Implements:</dt> <dd class="implements"><ul> <li>IUpdatePersistentSubscription</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line8958">line 8958</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="bufferSize"><span class="type-signature"></span>bufferSize<span class="type-signature"> :number</span></h4> <div class="description"> UpdatePersistentSubscription bufferSize. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9029">line 9029</a> </li></ul></dd> </dl> <h4 class="name" id="checkpointAfterTime"><span class="type-signature"></span>checkpointAfterTime<span class="type-signature"> :number</span></h4> <div class="description"> UpdatePersistentSubscription checkpointAfterTime. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9053">line 9053</a> </li></ul></dd> </dl> <h4 class="name" id="checkpointMaxCount"><span class="type-signature"></span>checkpointMaxCount<span class="type-signature"> :number</span></h4> <div class="description"> UpdatePersistentSubscription checkpointMaxCount. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9061">line 9061</a> </li></ul></dd> </dl> <h4 class="name" id="checkpointMinCount"><span class="type-signature"></span>checkpointMinCount<span class="type-signature"> :number</span></h4> <div class="description"> UpdatePersistentSubscription checkpointMinCount. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9069">line 9069</a> </li></ul></dd> </dl> <h4 class="name" id="eventStreamId"><span class="type-signature"></span>eventStreamId<span class="type-signature"> :string</span></h4> <div class="description"> UpdatePersistentSubscription eventStreamId. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line8973">line 8973</a> </li></ul></dd> </dl> <h4 class="name" id="liveBufferSize"><span class="type-signature"></span>liveBufferSize<span class="type-signature"> :number</span></h4> <div class="description"> UpdatePersistentSubscription liveBufferSize. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9013">line 9013</a> </li></ul></dd> </dl> <h4 class="name" id="maxRetryCount"><span class="type-signature"></span>maxRetryCount<span class="type-signature"> :number</span></h4> <div class="description"> UpdatePersistentSubscription maxRetryCount. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9037">line 9037</a> </li></ul></dd> </dl> <h4 class="name" id="messageTimeoutMilliseconds"><span class="type-signature"></span>messageTimeoutMilliseconds<span class="type-signature"> :number</span></h4> <div class="description"> UpdatePersistentSubscription messageTimeoutMilliseconds. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line8997">line 8997</a> </li></ul></dd> </dl> <h4 class="name" id="namedConsumerStrategy"><span class="type-signature"></span>namedConsumerStrategy<span class="type-signature"> :string</span></h4> <div class="description"> UpdatePersistentSubscription namedConsumerStrategy. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9085">line 9085</a> </li></ul></dd> </dl> <h4 class="name" id="preferRoundRobin"><span class="type-signature"></span>preferRoundRobin<span class="type-signature"> :boolean</span></h4> <div class="description"> UpdatePersistentSubscription preferRoundRobin. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9045">line 9045</a> </li></ul></dd> </dl> <h4 class="name" id="readBatchSize"><span class="type-signature"></span>readBatchSize<span class="type-signature"> :number</span></h4> <div class="description"> UpdatePersistentSubscription readBatchSize. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9021">line 9021</a> </li></ul></dd> </dl> <h4 class="name" id="recordStatistics"><span class="type-signature"></span>recordStatistics<span class="type-signature"> :boolean</span></h4> <div class="description"> UpdatePersistentSubscription recordStatistics. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9005">line 9005</a> </li></ul></dd> </dl> <h4 class="name" id="resolveLinkTos"><span class="type-signature"></span>resolveLinkTos<span class="type-signature"> :boolean</span></h4> <div class="description"> UpdatePersistentSubscription resolveLinkTos. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line8981">line 8981</a> </li></ul></dd> </dl> <h4 class="name" id="startFrom"><span class="type-signature"></span>startFrom<span class="type-signature"> :Long</span></h4> <div class="description"> UpdatePersistentSubscription startFrom. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Long</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line8989">line 8989</a> </li></ul></dd> </dl> <h4 class="name" id="subscriberMaxCount"><span class="type-signature"></span>subscriberMaxCount<span class="type-signature"> :number</span></h4> <div class="description"> UpdatePersistentSubscription subscriberMaxCount. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9077">line 9077</a> </li></ul></dd> </dl> <h4 class="name" id="subscriptionGroupName"><span class="type-signature"></span>subscriptionGroupName<span class="type-signature"> :string</span></h4> <div class="description"> UpdatePersistentSubscription subscriptionGroupName. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line8965">line 8965</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"> → {Object.<string, *>}</span></h4> <div class="description"> Converts this UpdatePersistentSubscription to JSON. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9460">line 9460</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> JSON object </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Object.<string, *></span> </dd> </dl> <h4 class="name" id=".create"><span class="type-signature">(static) </span>create<span class="signature">(properties<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="EventStore.Client.Messages.UpdatePersistentSubscription.html">EventStore.Client.Messages.UpdatePersistentSubscription</a>}</span></h4> <div class="description"> Creates a new UpdatePersistentSubscription instance using the specified properties. </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>properties</code></td> <td class="type"> <span class="param-type"><a href="EventStore.Client.Messages.IUpdatePersistentSubscription.html">EventStore.Client.Messages.IUpdatePersistentSubscription</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Properties to set</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9093">line 9093</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> UpdatePersistentSubscription instance </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="EventStore.Client.Messages.UpdatePersistentSubscription.html">EventStore.Client.Messages.UpdatePersistentSubscription</a></span> </dd> </dl> <h4 class="name" id=".decode"><span class="type-signature">(static) </span>decode<span class="signature">(reader, length<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="EventStore.Client.Messages.UpdatePersistentSubscription.html">EventStore.Client.Messages.UpdatePersistentSubscription</a>}</span></h4> <div class="description"> Decodes an UpdatePersistentSubscription message from the specified reader or buffer. </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>reader</code></td> <td class="type"> <span class="param-type">$protobuf.Reader</span> | <span class="param-type">Uint8Array</span> </td> <td class="attributes"> </td> <td class="description last">Reader or buffer to decode from</td> </tr> <tr> <td class="name"><code>length</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Message length if known beforehand</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9165">line 9165</a> </li></ul></dd> </dl> <h5>Throws:</h5> <ul> <li> <dl> <dt> <div class="param-desc"> If the payload is not a reader or valid buffer </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span> </dd> </dl> </dt> <dd></dd> </dl> </li> <li> <dl> <dt> <div class="param-desc"> If required fields are missing </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">$protobuf.util.ProtocolError</span> </dd> </dl> </dt> <dd></dd> </dl> </li> </ul> <h5>Returns:</h5> <div class="param-desc"> UpdatePersistentSubscription </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="EventStore.Client.Messages.UpdatePersistentSubscription.html">EventStore.Client.Messages.UpdatePersistentSubscription</a></span> </dd> </dl> <h4 class="name" id=".decodeDelimited"><span class="type-signature">(static) </span>decodeDelimited<span class="signature">(reader)</span><span class="type-signature"> → {<a href="EventStore.Client.Messages.UpdatePersistentSubscription.html">EventStore.Client.Messages.UpdatePersistentSubscription</a>}</span></h4> <div class="description"> Decodes an UpdatePersistentSubscription message from the specified reader or buffer, length delimited. </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>reader</code></td> <td class="type"> <span class="param-type">$protobuf.Reader</span> | <span class="param-type">Uint8Array</span> </td> <td class="description last">Reader or buffer to decode from</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9255">line 9255</a> </li></ul></dd> </dl> <h5>Throws:</h5> <ul> <li> <dl> <dt> <div class="param-desc"> If the payload is not a reader or valid buffer </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span> </dd> </dl> </dt> <dd></dd> </dl> </li> <li> <dl> <dt> <div class="param-desc"> If required fields are missing </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">$protobuf.util.ProtocolError</span> </dd> </dl> </dt> <dd></dd> </dl> </li> </ul> <h5>Returns:</h5> <div class="param-desc"> UpdatePersistentSubscription </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="EventStore.Client.Messages.UpdatePersistentSubscription.html">EventStore.Client.Messages.UpdatePersistentSubscription</a></span> </dd> </dl> <h4 class="name" id=".encode"><span class="type-signature">(static) </span>encode<span class="signature">(message, writer<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {$protobuf.Writer}</span></h4> <div class="description"> Encodes the specified UpdatePersistentSubscription message. Does not implicitly <a href="EventStore.Client.Messages.UpdatePersistentSubscription.html#.verify">verify</a> messages. </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>message</code></td> <td class="type"> <span class="param-type"><a href="EventStore.Client.Messages.IUpdatePersistentSubscription.html">EventStore.Client.Messages.IUpdatePersistentSubscription</a></span> </td> <td class="attributes"> </td> <td class="description last">UpdatePersistentSubscription message or plain object to encode</td> </tr> <tr> <td class="name"><code>writer</code></td> <td class="type"> <span class="param-type">$protobuf.Writer</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Writer to encode to</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9105">line 9105</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Writer </div> <dl> <dt> Type </dt> <dd> <span class="param-type">$protobuf.Writer</span> </dd> </dl> <h4 class="name" id=".encodeDelimited"><span class="type-signature">(static) </span>encodeDelimited<span class="signature">(message, writer<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {$protobuf.Writer}</span></h4> <div class="description"> Encodes the specified UpdatePersistentSubscription message, length delimited. Does not implicitly <a href="EventStore.Client.Messages.UpdatePersistentSubscription.html#.verify">verify</a> messages. </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>message</code></td> <td class="type"> <span class="param-type"><a href="EventStore.Client.Messages.IUpdatePersistentSubscription.html">EventStore.Client.Messages.IUpdatePersistentSubscription</a></span> </td> <td class="attributes"> </td> <td class="description last">UpdatePersistentSubscription message or plain object to encode</td> </tr> <tr> <td class="name"><code>writer</code></td> <td class="type"> <span class="param-type">$protobuf.Writer</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Writer to encode to</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9152">line 9152</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Writer </div> <dl> <dt> Type </dt> <dd> <span class="param-type">$protobuf.Writer</span> </dd> </dl> <h4 class="name" id=".fromObject"><span class="type-signature">(static) </span>fromObject<span class="signature">(object)</span><span class="type-signature"> → {<a href="EventStore.Client.Messages.UpdatePersistentSubscription.html">EventStore.Client.Messages.UpdatePersistentSubscription</a>}</span></h4> <div class="description"> Creates an UpdatePersistentSubscription message from a plain object. Also converts values to their respective internal types. </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>object</code></td> <td class="type"> <span class="param-type">Object.<string, *></span> </td> <td class="description last">Plain object</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9333">line 9333</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> UpdatePersistentSubscription </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="EventStore.Client.Messages.UpdatePersistentSubscription.html">EventStore.Client.Messages.UpdatePersistentSubscription</a></span> </dd> </dl> <h4 class="name" id=".getTypeUrl"><span class="type-signature">(static) </span>getTypeUrl<span class="signature">(typeUrlPrefix<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> <div class="description"> Gets the default type url for UpdatePersistentSubscription </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>typeUrlPrefix</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">your custom typeUrlPrefix(default "type.googleapis.com")</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9471">line 9471</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The default type url </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id=".toObject"><span class="type-signature">(static) </span>toObject<span class="signature">(message, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object.<string, *>}</span></h4> <div class="description"> Creates a plain object from an UpdatePersistentSubscription message. Also converts values to other types if specified. </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>message</code></td> <td class="type"> <span class="param-type"><a href="EventStore.Client.Messages.UpdatePersistentSubscription.html">EventStore.Client.Messages.UpdatePersistentSubscription</a></span> </td> <td class="attributes"> </td> <td class="description last">UpdatePersistentSubscription</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">$protobuf.IConversionOptions</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Conversion options</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9387">line 9387</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Plain object </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Object.<string, *></span> </dd> </dl> <h4 class="name" id=".verify"><span class="type-signature">(static) </span>verify<span class="signature">(message)</span><span class="type-signature"> → {string|null}</span></h4> <div class="description"> Verifies an UpdatePersistentSubscription message. </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>message</code></td> <td class="type"> <span class="param-type">Object.<string, *></span> </td> <td class="description last">Plain object to verify</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="messages_messages.js.html">messages/messages.js</a>, <a href="messages_messages.js.html#line9271">line 9271</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> `null` if valid, otherwise the reason why it is not </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> | <span class="param-type">null</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.0</a> on Mon Jan 30 2023 16:18:36 GMT-0500 (Eastern Standard Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>