Class: NewEvent

EventStore.Client.Messages.NewEvent(propertiesopt)

Represents a NewEvent.

Constructor

new NewEvent(propertiesopt)

Constructs a new NewEvent.
Parameters:
Name Type Attributes Description
properties EventStore.Client.Messages.INewEvent <optional>
Properties to set
Implements:
  • INewEvent
Source:

Members

data :Uint8Array

NewEvent data.
Type:
  • Uint8Array
Source:

dataContentType :number

NewEvent dataContentType.
Type:
  • number
Source:

eventId :Uint8Array

NewEvent eventId.
Type:
  • Uint8Array
Source:

eventType :string

NewEvent eventType.
Type:
  • string
Source:

metadata :Uint8Array

NewEvent metadata.
Type:
  • Uint8Array
Source:

metadataContentType :number

NewEvent metadataContentType.
Type:
  • number
Source:

Methods

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

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

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

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

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

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

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

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

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

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

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

(static) verify(message) → {string|null}

Verifies a NewEvent 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

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

Converts this NewEvent to JSON.
Source:
Returns:
JSON object
Type
Object.<string, *>