Sneak Peek: Improved TypeScript support in the Node SDK

[prathmesh-stripe]

We're excited to announce an improved TypeScript support in our Node SDK that will make your development experience smoother and more reliable. We have a dev branch which you can use to provide feedback before the official release by the end of March this year.

What we did:

• Moved the types from the partially manually maintained and partially generated types folder to be inline with the implementation in TypeScript files.
• Converted the default export stripe from a function to a class for cleaner extensibility.
• Removed top-level “stripe” ambient module. This allows import aliasing for the stripe package.

What this means for you:

🎯 Improved TypeScript Support
Get accurate autocomplete, better error detection, and reliable type checking in your IDE. No more type definition and implementation maintained separately and no more wrestling with mismatched types or missing definitions.

🚀 Easier upgrades & preview
Install more than one SDK version side-by-side. This allows you to do the below without updating your entire integration to use a different SDK version

• Test new features in a newer API version or features in public-preview and private-preview
• Incrementally upgrade different parts of your integration

✨ Cleaner module management
Enjoy simplified type declarations with no ambient modules, allowing you to alias the stripe package for the first time. Solves issues like #1636

Installation Instructions

We wanted to get this in your hands as quickly as possible. Therefore we decided to share this on our dev branch. We created a new dev branch to share early prototypes of new SDK features to get community feedback. The dev branch is API agnostic and may not always be at parity with the latest API release. To install the new SDK:

1. Install the dependency from the dev branch directly using npm

npm install stripe/stripe-node#dev --save

Note

Some APIs may not be available as this branch was built using the v20.1.0 Node SDK release.

Note

Please hold off from using this in your production systems until this makes it to our official release in March this year as we expect some interfaces to change between development build and the GA release.

TypeScript Example Script

Here’s an example script to help you quickly try out the new SDK. This syntax with types is compatible with our existing GA release and there are no breaking changes in this.

import Stripe from 'stripe';
const stripeClient = new Stripe('sk_test_...');

const params: Stripe.CustomerCreateParams = {
    description: 'test customer',
  };

const customer: Stripe.Customer = await stripeClient.customers.create(params);
console.log(customer.id);

Breaking changes

• Stripe.errors and Stripe.StripeContext are no longer exported as types. You can still reference them as Stripe.ErrorType and Stripe.StripeContextType

// Before
const context: Stripe.StripeContext = new Stripe.StripeContext();
// After
const context: Stripe.StripeContextType = new Stripe.StripeContext();

Known Issues

• Compatibility with CommonJS. We are still fixing the issues with CJS imports. ESM imports work as expected.