# IBM Aspera JavaScript SDK
This JavaScript SDK allows web applications to integrate with Aspera transfer clients to perform high-speed Aspera file transfers.

Supported transfer clients:
- IBM Aspera for desktop
- IBM Aspera HTTP Gateway
- IBM Aspera Connect

Example code is available on [GitHub Pages](https://ibm.github.io/aspera-sdk-js) with TypeDoc documentation [here](https://ibm.github.io/aspera-sdk-js/docs/).

## Installation
Install via npm:

```shell
$ npm install --save @ibm-aspera/sdk
```

To include this SDK via `script` tag directly in your web application's HTML, refer to third-party CDNs such as jsDelivr:

```html
<script src="https://cdn.jsdelivr.net/npm/@ibm-aspera/sdk@0.2.30/dist/js/aspera-sdk.js"></script>
```
Check npmjs.com for the latest version (https://www.npmjs.com/package/@ibm-aspera/sdk).

## Usage

The full API of this SDK can be found [here](https://ibm.github.io/aspera-sdk-js/docs/) with many [code examples](https://github.com/IBM/aspera-sdk-js/blob/main/examples).

Along with the examples, you can find an example test application [here](https://ibm.github.io/aspera-sdk-js/all).

## Migration from Connect SDK

Refer to [MIGRATION](https://github.com/IBM/aspera-sdk-js/blob/main/MIGRATION.md) for recommended changes when migrating your web application from the Connect SDK (`@ibm-aspera/connect-sdk-js`).