@onify/fake-amqplib 2.0.0 → 3.1.0

package/README.md

@@ -14,9 +14,10 @@ Mocked version of https://www.npmjs.com/package/amqplib.
 
 ## RabbitMQ versions
 
-Some behaviour differs between versions. To specify your version of RabbitMQ you can call `setVersion(minorVersionFloatOrString)`. Default version is 3.5.
+RabbitMQ behaviour differs between versions. To specify your version of RabbitMQ you can call `setVersion(minorVersionFloatOrString)`. Default version is 3.5.
 
 Example:
+
 ```js
 var fakeAmqp = require('@onify/fake-amqplib');
 
@@ -26,16 +27,16 @@ var fakeAmqp = require('@onify/fake-amqplib');
   const conn2 = await fakeAmqp.connect('amqp://rabbit2-2');
 
   fakeAmqp.setVersion('3.2');
-  const conn3 = await fakeAmqp.connect('amqp://rabbit3-1');
+  const conn3 = await fakeAmqp.connect('amqp://rabbit3-2');
 
   fakeAmqp.setVersion('3.7');
   const conn37 = await fakeAmqp.connect('amqp://rabbit3-7');
-})()
+})();
 ```
 
 ## Mocking amqplib
 
-You might want to override `amqplib` with `@onify/fake-amqplib` in tests. This can be done this way:
+You might want to override `amqplib` with `@onify/fake-amqplib` in tests. This can be done in a number of ways.
 
 ### CommonJS
 
@@ -72,9 +73,10 @@ Example on how to mock amqplib import when working with modules.
 
 **[Quibble](https://www.npmjs.com/package/quibble) mocha example**
 
-Both amqplib and fake-amqplib have to be mocked if reset mock is used during testing.
+Both amqplib and fake-amqplib have to be quibbled if reset mock is used during testing.
 
 _test/setup.js_
+
 ```js
 import * as fakeAmqpLib from '@onify/fake-amqplib';
 import { connect as fakeConnect } from '@onify/fake-amqplib';
@@ -88,19 +90,17 @@ import quibble from 'quibble';
 ```
 
 _.mocharc.json_ (true for node version < 20)
+
 ```json
 {
   "recursive": true,
   "require": ["test/setup.js"],
-  "node-option": [
-    "experimental-specifier-resolution=node",
-    "no-warnings",
-    "loader=quibble"
-  ]
+  "node-option": ["experimental-specifier-resolution=node", "no-warnings", "loader=quibble"]
 }
 ```
 
 _test/amqplib-connection-test.js_
+
 ```js
 import assert from 'node:assert';
 import { connect } from 'amqplib';

package/index.d.ts

@@ -1,28 +1,27 @@
 /// <reference types="amqplib" />
 /// <reference types="node" />
 
-import { Options, Connection, Channel, credentials } from "amqplib";
-import { EventEmitter } from "events";
+import { Options, Connection, Channel } from 'amqplib';
 import { Broker } from 'smqp';
 
 export interface FakeAmqplibChannel extends Channel {
+  /** Channel name and identifier, for faking purposes */
   _channelName: string;
-  _version: number;
   _broker: Broker;
-  new(broker: Broker, connection: FakeAmqplibConnection): FakeAmqplibChannel;
+  _version: number;
+  new (broker: Broker, connection: FakeAmqplibConnection): FakeAmqplibChannel;
   get _closed(): boolean;
-  get _emitter(): EventEmitter;
 }
 
 export interface FakeAmqplibConnection extends Connection {
   _channels: FakeAmqplibChannel[];
   _url: URL;
+  /** Connection identifier, for faking purposes */
   _id: string;
   _broker: Broker;
   _version: number;
-  new(broker: Broker, version: number, amqpUrl: string, options?: any): FakeAmqplibConnection;
+  new (broker: Broker, version: number, amqpUrl: string, options?: any): FakeAmqplibConnection;
   get _closed(): boolean;
-  get _emitter(): EventEmitter;
 }
 
 interface SocketOptions {
@@ -36,14 +35,11 @@ interface SocketOptions {
   [x: string]: any;
 }
 
-type connectCallback = (
-  err: Error,
-  connection: FakeAmqplibConnection
-) => void;
+type connectCallback = (err: Error, connection: FakeAmqplibConnection) => void;
 
 export class FakeAmqplib {
   connections: FakeAmqplibConnection[];
-  constructor(version?: number)
+  constructor(version?: number);
   connect(url: string | Options.Connect, socketOptions?: SocketOptions): Promise<FakeAmqplibConnection>;
   connect(url: string | Options.Connect, socketOptions: SocketOptions, callback: connectCallback): void;
   connect(url: string | Options.Connect, callback: (err: Error, connection: FakeAmqplibConnection) => void): void;