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

AMQPConnection overview

Added in v0.1.0


Table of contents


Layers

layer

Signature

export declare const layer: (
  url: internal.ConnectionUrl,
  options?: AMQPConnectionOptions
) => Layer.Layer<AMQPConnection, AMQPError.AMQPConnectionError>

Added in v0.1.0

constructors

make

Signature

export declare const make: (
  url: internal.ConnectionUrl,
  options?: AMQPConnectionOptions
) => Effect.Effect<AMQPConnection, AMQPError.AMQPConnectionError, Scope.Scope>

Added in v0.1.0

models

AMQPConnection (interface)

Signature

export interface AMQPConnection {
  readonly [TypeId]: TypeId
  readonly createChannel: Effect.Effect<Channel, AMQPError.AMQPConnectionError, never>
  readonly createConfirmChannel: Effect.Effect<ConfirmChannel, AMQPError.AMQPConnectionError, never>
  readonly serverProperties: Effect.Effect<AMQPConnectionServerProperties, AMQPError.AMQPConnectionError, never>
  readonly updateSecret: (
    ...params: Parameters<Connection["updateSecret"]>
  ) => Effect.Effect<void, AMQPError.AMQPConnectionError, never>

  /** @internal */
  readonly close: (options: internal.CloseConnectionOptions) => Effect.Effect<void, never, never>
}

Added in v0.1.0

AMQPConnectionOptions (type alias)

Signature

export type AMQPConnectionOptions = {
  retryConnectionSchedule?: Schedule.Schedule<unknown, AMQPError.AMQPConnectionError>
  waitConnectionTimeout?: Duration.DurationInput
}

Added in v0.4.0

AMQPConnectionServerProperties (type alias)

Signature

export type AMQPConnectionServerProperties = ServerProperties & {
  hostname: string | undefined
  port: string | undefined
}

Added in v0.2.5

tags

AMQPConnection

Signature

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

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