@znight/messaging 0.0.0-stage → 0.1.0

package/dist/rabbitmq.d.mts

@@ -0,0 +1,65 @@
+import { c as SubscribeOptions, f as OutboundMessage, i as DriverContext, l as Subscription, n as DeliveryHandler, o as MessagingDriver, r as DriverCapabilities } from "./driver-ZxLqy_Ap.mjs";
+import { Options, SocketOptions } from "amqplib";
+/** Reconnection settings. */
+export interface RabbitMQReconnectOptions {
+  /** First delay before reconnecting. Default: 100 ms. */
+  readonly initialDelayMs?: number;
+  /** Longest delay between attempts. Default: 30 000 ms. */
+  readonly maxDelayMs?: number;
+}
+/** Options of {@link rabbitmq}. */
+export interface RabbitMQDriverOptions {
+  /** `amqp://user:pass@host:5672/vhost` or amqplib connection options. */
+  readonly url: string | Options.Connect;
+  /** Socket / TLS options passed to amqplib. */
+  readonly socketOptions?: SocketOptions;
+  /**
+   * Declare the queues used by consumers (consumed, dead-letter and delay queues) and by delayed
+   * publications. When `false`, consumed and dead-letter queues must exist (verified at subscribe).
+   * Default: `true`.
+   */
+  readonly assertTopology?: boolean;
+  /** Type of the declared queues. Default: `quorum` (replicated, native `x-delivery-count`). */
+  readonly queueType?: "quorum" | "classic";
+  /**
+   * Extra arguments of declared consumed and dead-letter queues (`x-max-length`...). Quorum queues get
+   * `x-delivery-limit: -1` on RabbitMQ >= 4 unless this sets `x-delivery-limit`.
+   */
+  readonly queueArguments?: Readonly<Record<string, unknown>>;
+  /** Longest retry delay waited in-process (holding the message). Default: 5000 ms. */
+  readonly maxInProcessDelayMs?: number;
+  /** Name of the retry delay queue of `queue` for `delayMs`. Default: `${queue}.delay.${delayMs}`. */
+  readonly delayQueueName?: (queue: string, delayMs: number) => string;
+  /**
+   * Prefix of the delay levels of delayed publications: `<prefix>.0` to `<prefix>.31` (one topic
+   * exchange and one queue each, shared by every queue of the virtual host). Default: `znight.delays`.
+   */
+  readonly delayLevelPrefix?: string;
+  /** Default dead-letter queue name. Default: `${queue}.dlq`. */
+  readonly deadLetterName?: (queue: string) => string;
+  /** Publish with `mandatory`: unroutable messages make `publish()` fail. Default: `true`. */
+  readonly mandatory?: boolean;
+  /** Persistent messages (delivery mode 2). Default: `true`. */
+  readonly persistent?: boolean;
+  /** Use the routing key as message type when the message has none (topic exchanges). Default: `false`. */
+  readonly typeFromRoutingKey?: boolean;
+  /** Reconnect after a connection loss. `false` disables. Default: enabled. */
+  readonly reconnect?: RabbitMQReconnectOptions | false;
+  /** Connection name shown in the management UI. Default: `znight`. */
+  readonly connectionName?: string;
+}
+/** Creates a {@link RabbitMQDriver}. */
+export declare function rabbitmq(options: RabbitMQDriverOptions): RabbitMQDriver;
+/** RabbitMQ {@link MessagingDriver}. See the module documentation. */
+export declare class RabbitMQDriver implements MessagingDriver {
+  #private;
+  readonly name = "rabbitmq";
+  readonly capabilities: DriverCapabilities;
+  constructor(options: RabbitMQDriverOptions);
+  connect(context: DriverContext): Promise<void>;
+  close(): Promise<void>;
+  deadLetterName(queue: string): string;
+  publish(queue: string, message: OutboundMessage): Promise<void>;
+  subscribe(queue: string, handler: DeliveryHandler, options: SubscribeOptions): Promise<Subscription>;
+}
+//# sourceMappingURL=rabbitmq.d.mts.map