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

JetStreamDirectStreamAPI overview

Added in v0.1.0

Table of contents

models

JetStreamDirectStreamAPI (interface)

Represents a NATS JetStream Direct Stream API

Signature

export interface JetStreamDirectStreamAPI {
  readonly [TypeId]: TypeId
  readonly getMessage: (
    ...params: Parameters<JetStream.DirectStreamAPI["getMessage"]>
  ) => Effect.Effect<
    Option.Option<JetStreamStoredMessage.JetStreamStoredMessage>,
    NATSError.JetStreamDirectStreamAPIError,
    never
  >
  readonly getBatch: (
    ...params: Parameters<JetStream.DirectStreamAPI["getBatch"]>
  ) => Effect.Effect<
    NATSQueuedIterator.NATSQueuedIterator<JetStream.StoredMsg, NATSError.JetStreamDirectStreamAPIError>,
    NATSError.JetStreamDirectStreamAPIError,
    never
  >
  readonly getLastMessagesFor: (
    ...params: Parameters<JetStream.DirectStreamAPI["getLastMessagesFor"]>
  ) => Effect.Effect<
    NATSQueuedIterator.NATSQueuedIterator<JetStream.StoredMsg, NATSError.JetStreamDirectStreamAPIError>,
    NATSError.JetStreamDirectStreamAPIError,
    never
  >

  /** @internal */
  readonly direct: JetStream.DirectStreamAPI
}

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