@amndns/amqp-ts is a class-based wrapper module for the original yet legacy amqp-ts library.

✨ Features

Consumer

• class RabbitConsumer
  • function connect
  • function declareExchange
  • function declareQueue
  • function declareResources
  • function declareAdditionalResources
  • function run

Producer

• class RabbitProducer
  • function connect
  • function declareExchange
  • function publish
• decorator Producer

Utilities

• function consumerMessageTransformer
• function producerMessageTransformer

Types

• enum ContentType
• enum ExchangeType
• interface ExchangeOptions
• interface BaseConfig
• interface ConsumerConfig
• interface ProducerConfig
• interface MessageOptions
• type ConsumerCallback

Good for First Timers

• [ ] Add unit tests for the producer and consumer classes.
• [ ] Improve the channel disconnection logic of the producer class.

🚀 Get Started

This project was created using TypeScript.

Below is a guide on the common commands you might use all throughout the development process. In the project directory, you can run:

yarn install

Installs all package dependencies of the app. Make sure you have yarn installed and configured first.

yarn build-ts

Transpiles all of the .ts files from the src/ directory into .js CommonJS files. The target directory is in the dist/ folder.

yarn lint

Launches the linter against all of the .ts files from the src/ and test/ directory. The project specifically uses ESLint and Prettier as the linter and code formatter, respectively.

yarn test:unit

Launches the test runner in interactive watch mode using Jest. The test is launched against all of the .ts files from the test/ directory.

This README was generated with ❤️ by readme-md-generator