node-eventstore-client
Version:
A port of the EventStore .Net ClientAPI to Node.js
2,878 lines • 46.3 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: FilteredReadAllEventsCompleted</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: FilteredReadAllEventsCompleted</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>FilteredReadAllEventsCompleted<span class="signature">(properties<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
<div class="class-description">Represents a FilteredReadAllEventsCompleted.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="FilteredReadAllEventsCompleted"><span class="type-signature"></span>new FilteredReadAllEventsCompleted<span class="signature">(properties<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Constructs a new FilteredReadAllEventsCompleted.
</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.IFilteredReadAllEventsCompleted.html">EventStore.Client.Messages.IFilteredReadAllEventsCompleted</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>IFilteredReadAllEventsCompleted</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#line7670">line 7670</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="commitPosition"><span class="type-signature"></span>commitPosition<span class="type-signature"> :Long</span></h4>
<div class="description">
FilteredReadAllEventsCompleted commitPosition.
</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#line7678">line 7678</a>
</li></ul></dd>
</dl>
<h4 class="name" id="error"><span class="type-signature"></span>error<span class="type-signature"> :string</span></h4>
<div class="description">
FilteredReadAllEventsCompleted error.
</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#line7734">line 7734</a>
</li></ul></dd>
</dl>
<h4 class="name" id="events"><span class="type-signature"></span>events<span class="type-signature"> :Array.<<a href="EventStore.Client.Messages.IResolvedEvent.html">EventStore.Client.Messages.IResolvedEvent</a>></span></h4>
<div class="description">
FilteredReadAllEventsCompleted events.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="EventStore.Client.Messages.IResolvedEvent.html">EventStore.Client.Messages.IResolvedEvent</a>></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#line7694">line 7694</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isEndOfStream"><span class="type-signature"></span>isEndOfStream<span class="type-signature"> :boolean</span></h4>
<div class="description">
FilteredReadAllEventsCompleted isEndOfStream.
</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#line7718">line 7718</a>
</li></ul></dd>
</dl>
<h4 class="name" id="nextCommitPosition"><span class="type-signature"></span>nextCommitPosition<span class="type-signature"> :Long</span></h4>
<div class="description">
FilteredReadAllEventsCompleted nextCommitPosition.
</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#line7702">line 7702</a>
</li></ul></dd>
</dl>
<h4 class="name" id="nextPreparePosition"><span class="type-signature"></span>nextPreparePosition<span class="type-signature"> :Long</span></h4>
<div class="description">
FilteredReadAllEventsCompleted nextPreparePosition.
</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#line7710">line 7710</a>
</li></ul></dd>
</dl>
<h4 class="name" id="preparePosition"><span class="type-signature"></span>preparePosition<span class="type-signature"> :Long</span></h4>
<div class="description">
FilteredReadAllEventsCompleted preparePosition.
</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#line7686">line 7686</a>
</li></ul></dd>
</dl>
<h4 class="name" id="result"><span class="type-signature"></span>result<span class="type-signature"> :<a href="EventStore.Client.Messages.FilteredReadAllEventsCompleted.html#.FilteredReadAllResult">EventStore.Client.Messages.FilteredReadAllEventsCompleted.FilteredReadAllResult</a></span></h4>
<div class="description">
FilteredReadAllEventsCompleted result.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="EventStore.Client.Messages.FilteredReadAllEventsCompleted.html#.FilteredReadAllResult">EventStore.Client.Messages.FilteredReadAllEventsCompleted.FilteredReadAllResult</a></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#line7726">line 7726</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".FilteredReadAllResult"><span class="type-signature">(static) </span>FilteredReadAllResult<span class="type-signature"> :number</span></h4>
<div class="description">
FilteredReadAllResult enum.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Success</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Success value</td>
</tr>
<tr>
<td class="name"><code>NotModified</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">NotModified value</td>
</tr>
<tr>
<td class="name"><code>Error</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Error value</td>
</tr>
<tr>
<td class="name"><code>AccessDenied</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">AccessDenied value</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#line8115">line 8115</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 FilteredReadAllEventsCompleted 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#line8089">line 8089</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.FilteredReadAllEventsCompleted.html">EventStore.Client.Messages.FilteredReadAllEventsCompleted</a>}</span></h4>
<div class="description">
Creates a new FilteredReadAllEventsCompleted 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.IFilteredReadAllEventsCompleted.html">EventStore.Client.Messages.IFilteredReadAllEventsCompleted</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#line7742">line 7742</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
FilteredReadAllEventsCompleted instance
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="EventStore.Client.Messages.FilteredReadAllEventsCompleted.html">EventStore.Client.Messages.FilteredReadAllEventsCompleted</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.FilteredReadAllEventsCompleted.html">EventStore.Client.Messages.FilteredReadAllEventsCompleted</a>}</span></h4>
<div class="description">
Decodes a FilteredReadAllEventsCompleted 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#line7799">line 7799</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">
FilteredReadAllEventsCompleted
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="EventStore.Client.Messages.FilteredReadAllEventsCompleted.html">EventStore.Client.Messages.FilteredReadAllEventsCompleted</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.FilteredReadAllEventsCompleted.html">EventStore.Client.Messages.FilteredReadAllEventsCompleted</a>}</span></h4>
<div class="description">
Decodes a FilteredReadAllEventsCompleted 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#line7859">line 7859</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">
FilteredReadAllEventsCompleted
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="EventStore.Client.Messages.FilteredReadAllEventsCompleted.html">EventStore.Client.Messages.FilteredReadAllEventsCompleted</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 FilteredReadAllEventsCompleted message. Does not implicitly <a href="EventStore.Client.Messages.FilteredReadAllEventsCompleted.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.IFilteredReadAllEventsCompleted.html">EventStore.Client.Messages.IFilteredReadAllEventsCompleted</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">FilteredReadAllEventsCompleted 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#line7754">line 7754</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 FilteredReadAllEventsCompleted message, length delimited. Does not implicitly <a href="EventStore.Client.Messages.FilteredReadAllEventsCompleted.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.IFilteredReadAllEventsCompleted.html">EventStore.Client.Messages.IFilteredReadAllEventsCompleted</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">FilteredReadAllEventsCompleted 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#line7786">line 7786</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.FilteredReadAllEventsCompleted.html">EventStore.Client.Messages.FilteredReadAllEventsCompleted</a>}</span></h4>
<div class="description">
Creates a FilteredReadAllEventsCompleted 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#line7926">line 7926</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
FilteredReadAllEventsCompleted
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="EventStore.Client.Messages.FilteredReadAllEventsCompleted.html">EventStore.Client.Messages.FilteredReadAllEventsCompleted</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 FilteredReadAllEventsCompleted
</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#line8100">line 8100</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 a FilteredReadAllEventsCompleted 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.FilteredReadAllEventsCompleted.html">EventStore.Client.Messages.FilteredReadAllEventsCompleted</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">FilteredReadAllEventsCompleted</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#line8015">line 8015</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 a FilteredReadAllEventsCompleted 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#line7875">line 7875</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.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>