Skip to main content Link Search Menu Expand Document (external link)

JetStreamMessage overview

Added in v0.1.0


Table of contents


models

JetStreamMessage (interface)

Represents a JetStream message

Signature

export interface JetStreamMessage {
  readonly [TypeId]: TypeId
  readonly redelivered: boolean
  readonly info: JetStream.DeliveryInfo
  readonly seq: number
  readonly headers: Option.Option<NATSCore.MsgHdrs>
  readonly data: Uint8Array
  readonly subject: string
  readonly sid: number
  readonly time: Date
  readonly timestamp: string
  readonly timestampNanos: bigint
  readonly ack: Effect.Effect<void, NATSError.JetStreamMessageError>
  readonly nak: (...params: Parameters<JetStream.JsMsg["nak"]>) => Effect.Effect<void, NATSError.JetStreamMessageError>
  readonly working: Effect.Effect<void, NATSError.JetStreamMessageError>
  readonly term: (
    ...params: Parameters<JetStream.JsMsg["term"]>
  ) => Effect.Effect<void, NATSError.JetStreamMessageError>
  readonly ackAck: (
    ...params: Parameters<JetStream.JsMsg["ackAck"]>
  ) => Effect.Effect<boolean, NATSError.JetStreamMessageError>
  readonly json: <T = unknown>() => Effect.Effect<T, NATSError.JetStreamMessageError>
  readonly string: () => string

  /** @internal */
  readonly jsMsg: JetStream.JsMsg
}

Added in v0.1.0

type ids

TypeId

Signature

export declare const TypeId: typeof TypeId

Added in v0.1.0

TypeId (type alias)

Signature

export type TypeId = typeof TypeId

Added in v0.1.0