Skip to main content

Support

We will follow the guidelines listed in this document when it comes to versioning and releasing our JavaScript SDK. This includes what we support, how we version, and what we do in case of an issue with previous versions.

Versioning​

When we do releases of the JavaScript SDK, we will follow the same pattern every time. We will always follow Semver, so you can be confident in what you are upgrading based on the version.

  • MAJOR Versions (1.0.0) - We will release a major if we ever break any api's or functions exported from the package
  • MINOR Versions (0.1.0) - We will release a minor for any new features added to the package
  • PATCH Versions (0.0.1) - We will release a patch for any bug fixes we make

Docs​

All features will be tagged with which minor version the feature was released in via a Version Tag e.g. v1.2.0

Documentation for the two previous major versions will be maintained.

Version Support​

Once we release a major version, we will continue to move forward and that will get all bug fixes and new features. For previous versions we will no longer be adding features and will only fix bugs at our discretion. We will however guarantee support for the last 2 versions of our JavaScript SDK if any security issues surface. For example lets say we have a current version of 4.4.1 and the last majors were 3.12.1 and 2.20.4. If we find a security bug within our code and it stretches back to a previous release, we will incorporate the fix in both versions. So we would bump the current version to 4.4.2 and the previous versions would get bumped to 3.12.2 and 2.20.5.

Node Support​

Recharge JavaScript SDK is tested with and supports Node Active LTS.

Browser Support​

Recharge JavaScript SDK is tested with and supports all modern browsers and their latest versions.

We do not support older browsers that do not support ES6 such as Internet Explorer. You are welcome to add polyfills to make it work on older browsers, however you're on your own if you choose to take this approach.

Note: This is really only true when using the umd build. If you are using it as a module (esm/cjs), then it will be up to your build tools on what it supports.

TypeScript Support​

The Recharge JavaScript SDK is written in TypeScript and has full TypeScript support when using an IDE that supports it. This documentation also provides full typing information for all methods and objects. To browse the typing information click on the Types link in the navbar or click on the Types tag wherever you see one.

Deprecation​

APIs/Functions marked with Deprecated will be removed in the next major version release. Documentation will be provided for alternative usage.

License​

The JavaScript SDK is licensed under the MIT license

Copyright 2023 Recharge Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.