npm

Need private packages and team management tools?Check out npm Orgs. »

nestjs-stripe

0.2.1 • Public • Published

nestjs-stripe

Injectable Stripe client for your nestjs projects

Table Of Contents

About

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

Installation

npm install --save nestjs-stripe

Getting Started

The simplest way to use nestjs-stripe is to use StripeModule.forRoot

import { Module } from '@nestjs-common';
import { StripeModule } from 'nestjs-stripe';
 
@Module({
  imports: [
    StripeModule.forRoot({
      apiKey: 'my_secret_key',
    }),
  ],
})
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 { InjectStripe } from 'nestjs-stripe';
import * as Stripe from 'stripe';
 
@Injectable()
export class AppService {
  public constructor(@InjectStripe() private readonly stripeClient: Stripe) {}
}

Asynchronous setup is also supported

import { Module } from '@nestjs-common';
import { StripeModule } from 'nestjs-stripe';
 
@Module({
  imports: [
    StripeModule.forRootAsync({
      inject: [ConfigService],
      useFactory: (configService: ConfigService) => ({
        apiKey: configService.get('stripe_key'),
      }),
    }),
  ],
})
export class AppModule {}

Example

In order to run the example run the following commands in your terminal. The expected output of the example is to show that the Stripe client was successfully injected into the AppService.

cd example
yarn install
yarn start

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 MIT License. See LICENSE for more information.

Acknowledgements

Copyright © 2019 Dylan Aspden

install

npm i nestjs-stripe

Downloadsweekly downloads

431

version

0.2.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability