\n
\n Injectable Stripe client for your nestjs projects\n
\n\n\n> Fork of the original [nestjs-stripe](https://github.com/dhaspden/nestjs-stripe) with support for nestjs v10\n\n## Table Of Contents\n\n- [Table Of Contents](#table-of-contents)\n- [About](#about)\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [Example](#example)\n- [Contributing](#contributing)\n- [License](#license)\n- [Acknowledgements](#acknowledgements)\n\n## About\n\n`nestjs-stripe` implements a module, `StripeModule`, which when imported into\nyour nestjs project provides a Stripe client to any class that injects it. This\nlets Stripe be worked into your dependency injection workflow without having to\ndo any extra work outside of the initial setup.\n\n## Installation\n\n```bash\nnpm install --save nestjs-stripe\n```\n\n## Getting Started\n\nThe simplest way to use `nestjs-stripe` is to use `StripeModule.forRoot`\n\n```typescript\nimport { Module } from '@nestjs-common';\nimport { StripeModule } from 'nestjs-stripe';\n\n@Module({\n imports: [\n StripeModule.forRoot({\n apiKey: 'my_secret_key',\n apiVersion: '2020-08-27',\n }),\n ],\n})\nexport class AppModule {}\n```\n\nYou can then inject the Stripe client into any of your injectables by using a\ncustom decorator\n\n```typescript\nimport { Injectable } from '@nestjs/common';\nimport { InjectStripe } from 'nestjs-stripe';\nimport Stripe from 'stripe';\n\n@Injectable()\nexport class AppService {\n public constructor(@InjectStripe() private readonly stripeClient: Stripe) {}\n}\n```\n\nAsynchronous setup is also supported\n\n```typescript\nimport { Module } from '@nestjs-common';\nimport { StripeModule } from 'nestjs-stripe';\n\n@Module({\n imports: [\n StripeModule.forRootAsync({\n inject: [ConfigService],\n useFactory: (configService: ConfigService) => ({\n apiKey: configService.get('stripe_key'),\n apiVersion: '2020-08-27',\n }),\n }),\n ],\n})\nexport class AppModule {}\n```\n\nRead up on the `stripe-node` caveats\n[here](https://github.com/stripe/stripe-node#usage-with-typescript). Due to the\nway `stripe-node` works you can only use the latest version of the Stripe API\nthat was published at the time the module version was published. If you wish to\nuse an older version of the Stripe API, follow the steps in the above link.\nBecause of this, the `apiVersion` field is now required along with the `apiKey`\nfield.\n\n## Example\n\nIn order to run the example run the following commands in your terminal. The\nexpected output of the example is to show that the Stripe client was\nsuccessfully injected into the `AppService`.\n\n```bash\ncd example\nyarn install\nyarn start\n```\n\n## Contributing\n\nI would greatly appreciate any contributions to make this project better. Please\nmake sure to follow the below guidelines before getting your hands dirty.\n\n1. Fork the repository\n2. Create your branch (`git checkout -b my-branch`)\n3. Commit any changes to your branch\n4. Push your changes to your remote branch\n5. Open a pull request\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n## Acknowledgements\n\n- [nestjs](https://nestjs.com)\n- [stripe-node](https://github.com/stripe/stripe-node)\n\nCopyright © 2021 Dylan Aspden\n","readmeFilename":"README.md"}