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

NATSMessage overview

Added in v0.1.0


Table of contents


models

NATSMessage (interface)

Represents a NATS Message

Signature

export interface NATSMessage {
  readonly [TypeId]: TypeId
  readonly subject: string
  readonly sid: number
  readonly reply: Option.Option<string>
  readonly data: Uint8Array
  readonly headers: Option.Option<NATSCore.MsgHdrs>
  readonly respond: (
    ...params: Parameters<NATSCore.Msg["respond"]>
  ) => Effect.Effect<boolean, NATSError.NATSMessageError>
  readonly json: <T>(...params: Parameters<NATSCore.Msg["json"]>) => Effect.Effect<T, NATSError.NATSMessageError>
  readonly string: Effect.Effect<string, NATSError.NATSMessageError>

  /** @internal */
  readonly msg: NATSCore.Msg
}

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