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

JetStreamClient overview

Added in v0.1.0


Table of contents


Layers

layer

Signature

export declare const layer: (
  options?: JetStream.JetStreamOptions
) => Layer.Layer<JetStreamClient, NATSError.JetStreamClientError, NATSConnection.NATSConnection>

Added in v0.1.0

models

JetStreamClient (interface)

Represents a NATS JetStream Client

Signature

export interface JetStreamClient {
  readonly [TypeId]: TypeId
  readonly apiPrefix: string
  readonly publish: (
    ...params: Parameters<JetStream.JetStreamClient["publish"]>
  ) => Effect.Effect<JetStream.PubAck, NATSError.JetStreamClientError>
  readonly startBatch: (
    ...params: Parameters<JetStream.JetStreamClient["startBatch"]>
  ) => Effect.Effect<JetStreamBatch.JetStreamBatch, NATSError.JetStreamClientError>
  readonly options: Effect.Effect<JetStream.JetStreamOptions, NATSError.JetStreamClientError, never>
  readonly consumers: JetStreamConsumers.Consumers
  readonly streams: JetStreamStream.JetStreamStreams

  /** @internal */
  readonly js: JetStream.JetStreamClient
}

Added in v0.1.0

tags

JetStreamClient

Signature

export declare const JetStreamClient: Context.Tag<JetStreamClient, JetStreamClient>

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