Class: ReadEvent

EventStore.Client.Messages.ReadEvent(propertiesopt)

new ReadEvent(propertiesopt)

Constructs a new ReadEvent.
Parameters:
Name Type Attributes Description
properties EventStore.Client.Messages.ReadEvent$Properties <optional>
Properties to set
Source:

Members

eventNumber :number|Long

ReadEvent eventNumber.
Type:
  • number | Long
Source:

eventStreamId :string

ReadEvent eventStreamId.
Type:
  • string
Source:

requireMaster :boolean

ReadEvent requireMaster.
Type:
  • boolean
Source:

resolveLinkTos :boolean

ReadEvent resolveLinkTos.
Type:
  • boolean
Source:

Methods

(static) create(propertiesopt) → {EventStore.Client.Messages.ReadEvent}

Creates a new ReadEvent instance using the specified properties.
Parameters:
Name Type Attributes Description
properties EventStore.Client.Messages.ReadEvent$Properties <optional>
Properties to set
Source:
Returns:
ReadEvent instance
Type
EventStore.Client.Messages.ReadEvent

(static) decode(reader, lengthopt) → {EventStore.Client.Messages.ReadEvent}

Decodes a ReadEvent 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:
ReadEvent
Type
EventStore.Client.Messages.ReadEvent

(static) decodeDelimited(reader) → {EventStore.Client.Messages.ReadEvent}

Decodes a ReadEvent 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:
ReadEvent
Type
EventStore.Client.Messages.ReadEvent

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified ReadEvent message. Does not implicitly verify messages.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.ReadEvent$Properties ReadEvent 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 ReadEvent message, length delimited. Does not implicitly verify messages.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.ReadEvent$Properties ReadEvent 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.ReadEvent}

Creates a ReadEvent message from a plain object. Also converts values to their respective internal types. This is an alias of EventStore.Client.Messages.ReadEvent.fromObject.
Parameters:
Name Type Description
object Object.<string, *> Plain object
Source:
Returns:
ReadEvent
Type
EventStore.Client.Messages.ReadEvent

(static) fromObject(object) → {EventStore.Client.Messages.ReadEvent}

Creates a ReadEvent message from a plain object. Also converts values to their respective internal types.
Parameters:
Name Type Description
object Object.<string, *> Plain object
Source:
Returns:
ReadEvent
Type
EventStore.Client.Messages.ReadEvent

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a ReadEvent message. Also converts values to other types if specified.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.ReadEvent ReadEvent
options $protobuf.ConversionOptions <optional>
Conversion options
Source:
Returns:
Plain object
Type
Object.<string, *>

(static) verify(message) → (nullable) {string}

Verifies a ReadEvent 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 ReadEvent to JSON.
Source:
Returns:
JSON object
Type
Object.<string, *>

toObject(optionsopt) → {Object.<string, *>}

Creates a plain object from this ReadEvent 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, *>