1.0.1 • Published 5 years ago
nestjs-hubspot v1.0.1
Table Of Contents
About
nestjs-hubspot
implements a module, HubspotModule
, which when imported into
your nestjs project provides a Hubspot client to any class that injects it.
Installation
npm install --save nestjs-hubspot
// Or with yarn
yarn add nestjs-hubspot
Getting Started
The simplest way to use nestjs-hubspot
is to use HubspotModule.forRoot
import { Module } from '@nestjs-common';
import { HubspotModule } from 'nestjs-hubspot';
@Module({
imports: [
HubspotModule.forRoot({
apiKey: 'my_secret_key',
}),
],
})
export class AppModule {}
You can then inject the Hubspot client into any of your injectables by using a custom decorator
import { Injectable } from '@nestjs/common';
import { InjectHubspot } from 'nestjs-hubspot';
import Hubspot from 'hubspot';
@Injectable()
export class AppService {
public constructor(
@InjectHubspot() private readonly hubspotClient: Hubspot,
) {}
}
Asynchronous setup is also supported
import { Module } from '@nestjs-common';
import { HubspotModule } from 'nestjs-hubspot';
@Module({
imports: [
HubspotModule.forRootAsync({
// inject: [ConfigService], with configService
useFactory: (/* configService: ConfigService */) => ({
apiKey: process.env.API_KEY, // configService.get('hubspot_api_key'),
}),
}),
],
})
export class AppModule {}
Example
Coming soon...
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 MIT License. See LICENSE
for more information.
Acknowledgements
Copyright © 2020 Maréchal Olivier