@ntegral/nestjs-mailchimp

@ntegral/nestjs-mailchimp

Provides an injectable mailchimp client to provide features to the Mailchimp API for nestjs projects

Table Of Contents

• About
• Installation
• Getting Started
• Contributing
• License
• Acknowledgements

About

@ntegral/nestjs-mailchimp implements a module, MailchimpModule, which when imported into your nestjs project provides a mailchimp client to any class that injects it. This lets mailchimp be worked into your dependency injection workflow without having to do any extra work outside of the initial setup.

Installation

npm install --save @ntegral/nestjs-mailchimp mailchimp-api-v3

Getting Started

The simplest way to use @ntegral/nestjs-mailchimp is to use MailchimpModule.forRoot

import { Module } from '@nestjs-common';
import { MailchimpModule } from '@ntegral/nestjs-wpapi';

@Module({
  imports: [
    MailchimpModule.forRoot({
      apikey: 'mailchimp api key'
    }),
  ],
})
export class AppModule {}

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

import { Injectable } from '@nestjs/common';
import { InjectMailchimp } from '@ntegral/nestjs-mailchimp';
import Mailchimp = require('mailchimp-api-v3');

@Injectable()
export class AppService {
  public constructor(@InjectMailchimp private readonly client: Client) {}
}

Asynchronous setup is also supported

import { Module } from '@nestjs-common';
import { ConfigModule } from '../common/config/config.module';
import { ConfigService } from '../common/config/config.service';
import { MailchimpModule } from '@ntegral/nestjs-mailchimp';

@Module({
  imports: [
    MailchimpModule.forRootAsync({
      imports: [ConfigModule],  
      inject: [ConfigService],
      useFactory: (cfg: ConfigService) => ({
        apikey: 'some mailchimp api 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.

1. Fork the repository
2. Create your branch (git checkout -b my-branch)
3. Commit any changes to your branch
4. Push your changes to your remote branch
5. Open a pull request

License

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

Acknowledgements

• nestjs
• mailchimp-api-v3

Copyright © 2020 Ntegral Inc.