Installation

Source Repository: convertcom/javascript-sdk | Wiki | npm

Install via npm or Yarn

npm install --save @convertcom/js-sdk

Or:

yarn add @convertcom/js-sdk

Bundle Formats

The package provides entry points in multiple formats:

Format	File	Minified
CommonJS (CJS)	`lib/index.js`	`lib/index.min.js`
ES Modules (ESM)	`lib/index.mjs`	`lib/index.min.mjs`
Universal Module Definition (UMD)	`lib/index.umd.js`	`lib/index.umd.min.js`

CDN (unpkg)

You can also load the SDK via unpkg (evaluation purposes only):

<script src="https://unpkg.com/@convertcom/js-sdk/lib/index.js"></script>

<!-- or minified -->
<script src="https://unpkg.com/@convertcom/js-sdk/lib/index.min.js"></script>

Importing the SDK

ES6

For modern frontend frameworks (React, Vue, Angular). Must be transpiled for browsers.

import ConvertSDK from '@convertcom/js-sdk';

ESM

For ES Module packages ("type": "module" in package.json). Must be transpiled for browsers.

import ConvertSDKModule from '@convertcom/js-sdk';
const ConvertSDK = (ConvertSDKModule as any).default;

CommonJS

For Node.js environments. Must be transpiled for browsers.

const {default: ConvertSDK} = require('@convertcom/js-sdk');

UMD

Works directly in browsers.

<script src="https://unpkg.com/@convertcom/js-sdk/lib/index.umd.min.js"></script>

const {default: ConvertSDK} = window.ConvertSDK;

Next Steps

Initialization -- configure and start the SDK
Quickstart -- full working example