Node SDK

Interface WriteEvent<T>

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Enumeration
  • Class

An event that is written to an RStreams queue. This is a wrapper around the data you care about T which is stored in the payload attribute.

Type parameters

  • T

    The data that is stored in the event in the payload attribute

Hierarchy

Index

Properties

Properties

Optional correlation_id

correlation_id?: CorrelationId

Reference the doc on [CorrelationId] that describes this well.

event

event: string

This is the name of the RStreams queue this event is in

Optional event_source_timestamp

event_source_timestamp?: number

The timestamp of the first event that made it to the bus that this event eventually derived from, however far back upstream.

default

now

id

id: string

The ID of the bot that wrote this event to the queue

Optional payload

payload?: T

The RStreams queue-specific data that this event exists to wrap

Optional timestamp

timestamp?: number

The millisecond (time since epoch) of when this event was created by the developer.

default

now

Generated using TypeDoc