nest-resend
v3.0.0
Published
NestJS Resend Library
Downloads
183
Readme
Table Of Contents
About
nest-resend
implements a module, ResendModule
, which when imported into
your nestjs project provides a Resend client to any class that injects it. This
lets Resend be worked into your dependency injection workflow without having to
do any extra work outside of the initial setup.
Installation
npm install --save nest-resend
Getting Started
The simplest way to use nest-resend
is to use ResendModule.forRoot
import { Module } from '@nestjs-common';
import { ResendModule } from 'nest-resend';
@Module({
imports: [
ResendModule.forRoot({
apiKey: 're_secret_key'
}),
],
})
export class AppModule {}
You can then inject the Resend client into any of your injectables by using a custom decorator
import { Injectable } from '@nestjs/common';
import { InjectResend } from 'nest-resend';
import { Resend } from 'resend';
@Injectable()
export class AppService {
public constructor(@InjectResend() private readonly resendClient: Resend) {}
sendEmail() {
return this.resendClient.emails.send({
from: '[email protected]',
to: '[email protected]',
subject: 'Howdy!',
html: '<strong>YAY!</strong>',
});
}
}
Asynchronous setup is also supported
import { Module } from '@nestjs-common';
import { ResendModule } from 'nest-resend';
@Module({
imports: [
ResendModule.forRootAsync({
inject: [ConfigService],
useFactory: (configService: ConfigService) => ({
apiKey: configService.get('resend_key')
}),
}),
],
})
export class AppModule {}
Contributing
I would greatly appreciate any contributions to make this project better. Please make sure to follow the below guidelines before getting your hands dirty.
- Fork the repository
- Create your branch (
git checkout -b my-branch
) - Commit any changes to your branch
- Push your changes to your remote branch
- Open a pull request
License
Distributed under the APACHE2 License. See LICENSE
for more information.
Acknowledgements
Copyright © 2022 Ivan Santos