@mehulbaid/nest-sendgrid

SendGrid Extension Library for NestJS based projects.

About
Installation
Getting Started
Contributing
License
Acknowledgements

About

@mehulbaid/nest-sendgrid provides a modular way to use SendGrid which when imported into your nestjs project provides an instance of the @sendgrid/mail client to any Module that injects it.

Packge Versions

Package Version	Nestjs Version
1.x.x	^6.x.x
2.x.x	^7.x.x
3.x.x	^8.x.x

Installation

npm install --save @mehulbaid/nest-sendgrid @sendgrid/mail

Getting Started

The simplest way to use @mehulbaid/nest-sendgrid is to use SendGridModule.forRoot

import { Module } from '@nestjs/common';
import { SendGridModule } from '@mehulbaid/nest-sendgrid';

@Module({
  imports: [
    SendGridModule.forRoot({
      apiKey: 'my_secret_key',
    }),
  ],
})
export class AppModule {}

The async way @mehulbaid/nest-sendgrid is to use SendGridModule.forRootAsync

import { Module } from '@nestjs/common';
import { SendGridModule } from '@mehulbaid/nest-sendgrid';
import { ConfigModule, ConfigService } from '@nestjs/config';

@Module({
  imports: [
    SendGridModule.forRootAsync({
      imports: [ConfigModule],
      useFactory: async (cfg:ConfigService) => ({
        apiKey: cfg.get('SENDGRID_API_KEY'),
      }),
      inject: [ConfigService],
    })
  ]
})

export class AppModule {}

You can then inject the Stripe client into any of your injectables by using a custom decorator

import { Injectable } from '@nestjs/common';
import { InjectSendGrid, SendGridService } from '@mehulbaid/nest-sendgrid';

@Injectable()
export class AppService {
  public constructor(@InjectSendGrid() private readonly client: SendGridService) {}
}

License

Distributed under the MIT License. See LICENSE for more information.