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

NATSConnection overview

Added in v0.1.0


Table of contents


Layers

layerNode

Signature

export declare const layerNode: (
  options: TransportNode.NodeConnectionOptions
) => Layer.Layer<NATSConnection, NATSError.NATSConnectionError>

Added in v0.1.0

layerWebSocket

Signature

export declare const layerWebSocket: (
  options: NATSCore.ConnectionOptions
) => Layer.Layer<NATSConnection, NATSError.NATSConnectionError>

Added in v0.1.0

models

NATSConnection (interface)

Represents a NATS Connection

Signature

export interface NATSConnection {
  readonly [TypeId]: TypeId
  info: Option.Option<NATSCore.ServerInfo>
  readonly publish: (
    ...params: Parameters<NATSCore.NatsConnection["publish"]>
  ) => Effect.Effect<void, NATSError.NATSConnectionError>
  readonly publishMessage: (
    ...params: Parameters<NATSCore.NatsConnection["publishMessage"]>
  ) => Effect.Effect<void, NATSError.NATSConnectionError>
  readonly respondMessage: (
    ...params: Parameters<NATSCore.NatsConnection["respondMessage"]>
  ) => Effect.Effect<boolean, NATSError.NATSConnectionError>
  readonly request: (
    ...params: Parameters<NATSCore.NatsConnection["request"]>
  ) => Effect.Effect<NATSMessage.NATSMessage, NATSError.NATSConnectionError>
  readonly subscribe: (
    ...params: Parameters<NATSCore.NatsConnection["subscribe"]>
  ) => Effect.Effect<NATSSubscription.NATSSubscription, NATSError.NATSConnectionError>
  readonly flush: Effect.Effect<void, NATSError.NATSConnectionError>
  readonly requestMany: (
    ...params: Parameters<NATSCore.NatsConnection["requestMany"]>
  ) => Effect.Effect<
    Stream.Stream<NATSMessage.NATSMessage, NATSError.NATSConnectionError>,
    NATSError.NATSConnectionError
  >
  readonly getServer: Effect.Effect<string, NATSError.NATSConnectionError>
  readonly status: Effect.Effect<
    Stream.Stream<NATSCore.Status, NATSError.NATSConnectionError>,
    NATSError.NATSConnectionError
  >
  readonly stats: Effect.Effect<NATSCore.Stats, NATSError.NATSConnectionError>
  readonly rtt: Effect.Effect<number, NATSError.NATSConnectionError>

  /** @internal */
  readonly nc: NATSCore.NatsConnection
}

Added in v0.1.0

tags

NATSConnection

Signature

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

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