Constructor
new FilteredReadAllEvents(propertiesopt)
Constructs a new FilteredReadAllEvents.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
EventStore.Client.Messages.IFilteredReadAllEvents |
<optional> |
Properties to set |
- Implements:
- IFilteredReadAllEvents
- Source:
Members
commitPosition :Long
FilteredReadAllEvents commitPosition.
Type:
- Long
- Source:
filter :EventStore.Client.Messages.IFilter
FilteredReadAllEvents filter.
Type:
- Source:
maxCount :number
FilteredReadAllEvents maxCount.
Type:
- number
- Source:
maxSearchWindow :number
FilteredReadAllEvents maxSearchWindow.
Type:
- number
- Source:
preparePosition :Long
FilteredReadAllEvents preparePosition.
Type:
- Long
- Source:
requireLeader :boolean
FilteredReadAllEvents requireLeader.
Type:
- boolean
- Source:
resolveLinkTos :boolean
FilteredReadAllEvents resolveLinkTos.
Type:
- boolean
- Source:
Methods
toJSON() → {Object.<string, *>}
Converts this FilteredReadAllEvents to JSON.
- Source:
Returns:
JSON object
- Type
- Object.<string, *>
(static) create(propertiesopt) → {EventStore.Client.Messages.FilteredReadAllEvents}
Creates a new FilteredReadAllEvents instance using the specified properties.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
EventStore.Client.Messages.IFilteredReadAllEvents |
<optional> |
Properties to set |
- Source:
Returns:
FilteredReadAllEvents instance
(static) decode(reader, lengthopt) → {EventStore.Client.Messages.FilteredReadAllEvents}
Decodes a FilteredReadAllEvents message from the specified reader or buffer.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reader |
$protobuf.Reader | Uint8Array | Reader or buffer to decode from | |
length |
number |
<optional> |
Message length if known beforehand |
- Source:
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
Returns:
FilteredReadAllEvents
(static) decodeDelimited(reader) → {EventStore.Client.Messages.FilteredReadAllEvents}
Decodes a FilteredReadAllEvents message from the specified reader or buffer, length delimited.
Parameters:
Name | Type | Description |
---|---|---|
reader |
$protobuf.Reader | Uint8Array | Reader or buffer to decode from |
- Source:
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
Returns:
FilteredReadAllEvents
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified FilteredReadAllEvents message. Does not implicitly verify messages.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
EventStore.Client.Messages.IFilteredReadAllEvents | FilteredReadAllEvents message or plain object to encode | |
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
- Source:
Returns:
Writer
- Type
- $protobuf.Writer
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified FilteredReadAllEvents message, length delimited. Does not implicitly verify messages.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
EventStore.Client.Messages.IFilteredReadAllEvents | FilteredReadAllEvents message or plain object to encode | |
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
- Source:
Returns:
Writer
- Type
- $protobuf.Writer
(static) fromObject(object) → {EventStore.Client.Messages.FilteredReadAllEvents}
Creates a FilteredReadAllEvents message from a plain object. Also converts values to their respective internal types.
Parameters:
Name | Type | Description |
---|---|---|
object |
Object.<string, *> | Plain object |
- Source:
Returns:
FilteredReadAllEvents
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for FilteredReadAllEvents
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
- Source:
Returns:
The default type url
- Type
- string
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a FilteredReadAllEvents message. Also converts values to other types if specified.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
EventStore.Client.Messages.FilteredReadAllEvents | FilteredReadAllEvents | |
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
- Source:
Returns:
Plain object
- Type
- Object.<string, *>
(static) verify(message) → {string|null}
Verifies a FilteredReadAllEvents message.
Parameters:
Name | Type | Description |
---|---|---|
message |
Object.<string, *> | Plain object to verify |
- Source:
Returns:
`null` if valid, otherwise the reason why it is not
- Type
- string | null