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

NATSSubscription overview

Added in v0.1.0

Table of contents

models

NATSSubscription (interface)

Represents a NATS Message

Signature

export interface NATSSubscription {
  readonly [TypeId]: TypeId
  readonly stream: Stream.Stream<NATSMessage.NATSMessage, NATSError.NATSSubscriptionError>

  readonly unsubscribe: (
    ...params: Parameters<NATSCore.Subscription["unsubscribe"]>
  ) => Effect.Effect<void, NATSError.NATSSubscriptionError>
  readonly drain: Effect.Effect<void, NATSError.NATSSubscriptionError>
  readonly isDraining: Effect.Effect<boolean, NATSError.NATSSubscriptionError>
  readonly isClosed: Effect.Effect<boolean, NATSError.NATSSubscriptionError>
  readonly getSubject: Effect.Effect<string, NATSError.NATSSubscriptionError>
  readonly getReceived: Effect.Effect<number, NATSError.NATSSubscriptionError>
  readonly getProcessed: Effect.Effect<number, NATSError.NATSSubscriptionError>
  readonly getPending: Effect.Effect<number, NATSError.NATSSubscriptionError>
  readonly getMax: Effect.Effect<Option.Option<number>, NATSError.NATSSubscriptionError>

  /** @internal */
  readonly sub: NATSCore.Subscription
}

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