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

JetStreamStreamAPI overview

Added in v0.1.0


Table of contents


models

JetStreamStreamAPI (interface)

Represents a NATS JetStream Stream API

Signature

export interface JetStreamStreamAPI {
  readonly [TypeId]: TypeId
  readonly info: (
    ...params: Parameters<JetStream.StreamAPI["info"]>
  ) => Effect.Effect<JetStream.StreamInfo, NATSError.JetStreamStreamAPIError, never>
  readonly add: (
    ...params: Parameters<JetStream.StreamAPI["add"]>
  ) => Effect.Effect<JetStream.StreamInfo, NATSError.JetStreamStreamAPIError, never>
  readonly update: (
    ...params: Parameters<JetStream.StreamAPI["update"]>
  ) => Effect.Effect<JetStream.StreamInfo, NATSError.JetStreamStreamAPIError, never>
  readonly purge: (
    ...params: Parameters<JetStream.StreamAPI["purge"]>
  ) => Effect.Effect<JetStream.PurgeResponse, NATSError.JetStreamStreamAPIError, never>
  readonly delete: (
    ...params: Parameters<JetStream.StreamAPI["delete"]>
  ) => Effect.Effect<boolean, NATSError.JetStreamStreamAPIError, never>
  readonly list: (
    ...params: Parameters<JetStream.StreamAPI["list"]>
  ) => Effect.Effect<
    JetStreamLister.JetStreamLister<JetStream.StreamInfo, NATSError.JetStreamStreamAPIError>,
    NATSError.JetStreamStreamAPIError,
    never
  >
  readonly deleteMessage: (
    ...params: Parameters<JetStream.StreamAPI["deleteMessage"]>
  ) => Effect.Effect<boolean, NATSError.JetStreamStreamAPIError, never>
  readonly getMessage: (
    ...params: Parameters<JetStream.StreamAPI["getMessage"]>
  ) => Effect.Effect<
    Option.Option<JetStreamStoredMessage.JetStreamStoredMessage>,
    NATSError.JetStreamStreamAPIError,
    never
  >
  readonly find: (
    ...params: Parameters<JetStream.StreamAPI["find"]>
  ) => Effect.Effect<string, NATSError.JetStreamStreamAPIError, never>
  readonly names: (
    ...params: Parameters<JetStream.StreamAPI["names"]>
  ) => Effect.Effect<
    JetStreamLister.JetStreamLister<string, NATSError.JetStreamStreamAPIError>,
    NATSError.JetStreamStreamAPIError,
    never
  >

  /** @internal */
  readonly streams: JetStream.StreamAPI
}

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