new WriteEvents(propertiesopt)
Constructs a new WriteEvents.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
EventStore.Client.Messages.WriteEvents$Properties |
<optional> |
Properties to set |
- Source:
Members
events :Array.<EventStore.Client.Messages.NewEvent$Properties>
WriteEvents events.
Type:
- Source:
eventStreamId :string
WriteEvents eventStreamId.
Type:
- string
- Source:
expectedVersion :number
WriteEvents expectedVersion.
Type:
- number
- Source:
requireMaster :boolean
WriteEvents requireMaster.
Type:
- boolean
- Source:
Methods
(static) create(propertiesopt) → {EventStore.Client.Messages.WriteEvents}
Creates a new WriteEvents instance using the specified properties.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
EventStore.Client.Messages.WriteEvents$Properties |
<optional> |
Properties to set |
- Source:
Returns:
WriteEvents instance
(static) decode(reader, lengthopt) → {EventStore.Client.Messages.WriteEvents}
Decodes a WriteEvents 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:
WriteEvents
(static) decodeDelimited(reader) → {EventStore.Client.Messages.WriteEvents}
Decodes a WriteEvents 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:
WriteEvents
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified WriteEvents message. Does not implicitly verify messages.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
EventStore.Client.Messages.WriteEvents$Properties | WriteEvents 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 WriteEvents message, length delimited. Does not implicitly verify messages.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
EventStore.Client.Messages.WriteEvents$Properties | WriteEvents message or plain object to encode | |
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
- Source:
Returns:
Writer
- Type
- $protobuf.Writer
(static) from(object) → {EventStore.Client.Messages.WriteEvents}
Creates a WriteEvents message from a plain object. Also converts values to their respective internal types.
This is an alias of EventStore.Client.Messages.WriteEvents.fromObject.
Parameters:
Name | Type | Description |
---|---|---|
object |
Object.<string, *> | Plain object |
- Source:
Returns:
WriteEvents
(static) fromObject(object) → {EventStore.Client.Messages.WriteEvents}
Creates a WriteEvents message from a plain object. Also converts values to their respective internal types.
Parameters:
Name | Type | Description |
---|---|---|
object |
Object.<string, *> | Plain object |
- Source:
Returns:
WriteEvents
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a WriteEvents message. Also converts values to other types if specified.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
EventStore.Client.Messages.WriteEvents | WriteEvents | |
options |
$protobuf.ConversionOptions |
<optional> |
Conversion options |
- Source:
Returns:
Plain object
- Type
- Object.<string, *>
(static) verify(message) → (nullable) {string}
Verifies a WriteEvents 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
toJSON() → {Object.<string, *>}
Converts this WriteEvents to JSON.
- Source:
Returns:
JSON object
- Type
- Object.<string, *>
toObject(optionsopt) → {Object.<string, *>}
Creates a plain object from this WriteEvents message. Also converts values to other types if specified.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
$protobuf.ConversionOptions |
<optional> |
Conversion options |
- Source:
Returns:
Plain object
- Type
- Object.<string, *>