Giter VIP home page Giter VIP logo

nest-rabbitmq's Introduction

@mikilian/nest-rabbitmq

A wrapper of the AMQP library for NestJS to provide fast communication between services. The idea behind it is to provide possible ways of communication with a message system without having to write a lot of code.

Installation

Consider adding @types/amqplib as development dependency when using TypeScript

# using yarn
yarn install @mikilian/nest-rabbitmq

# using npm
npm install --save @mikilian/nest-rabbitmq

Usage

import { Module } from '@nestjs/common';
import { RabbitMQModule } from '@mikilian/nest-rabbitmq'

@Module({
    imports: [
        RabbitMQModule.forRoot({
            hostname: 'localhost',
            username: 'admin',
            password: 'pw'
        }),
    ]
})
export class AppModule {}

You can also use a factory to create the configuration file.

import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { RabbitMQModule } from '@mikilian/nest-rabbitmq'

@Module({
    imports: [
        RabbitMQModule.forRootAsync({
            imports: [ConfigModule],
            useFactory: (config: ConfigService) => ({
                hostname: config.get('ENV_FOR_HOSTNAME') as string,
                username: config.get('ENV_FOR_USERNAME') as string,
                password: config.get('ENV_FOR_PASSWORD') as string,
            }),
            inject: [ConfigService]
        })
    ]
})
export class AppModule {}

Examples

To run the examples, a RabbitMQ server is required. Afterwards three environment variables are needed, so it is recommended to export them in the terminal.

export AMQP_HOSTNAME=''
export AMQP_USERNAME=''
export AMQP_PASSWORD=''

Now any example can be executed using yarn run example:<ID>. The code can be found in the examples directory.

nest-rabbitmq's People

Contributors

mikilian avatar

Watchers

 avatar

nest-rabbitmq's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.