Installation - Storm JavaScript Library

Storm JavaScript Library can be easily installed using popular package managers like npm and yarn. You can also attach js file from our CDN. Below you'll find more detailed instructions.

Storm CDN

Feel free to pick our Storm Library (in IIFE format) from our CDN:

                        
<script src="https://cdn.stormstreaming.com/stormlibrary/2-latest.min.js"></script>
                            

Optionally you can link to the latest major.minor, for example 2.2-latest.min.js, or pick specific release: 2.2.0.min.js

To embed the library on your website you can use our CDN hosted file. It's based on IIFE and it's compatible with all modern browsers! Latest version can be found on our github page: https://github.com/StormStreaming/stormlibrary-js/releases

Install via package managers

  1. Node

    To include Storm Library in Node, first install NPM

                                    
    npm install @stormstreaming/stormlibrary
                                
  2. Yarn

    Before using Yarn, make sure to install it first

                                    
    yarn add @stormstreaming/stormlibrary
                                

Manual installation

You can manually grab index.js from /dist/iife folder on our Git-Hub page. You will find the latest release here: https://github.com/StormStreaming/stormlibrary-js/releases

Embedding the library

Storm Library comes in IIFE, ESM, AMD, UMD and CJS formats. If you are unfamiliar with these, please grab IIFE version, as it's easiest to embed in a modern browser. All packages are located in /dist folder under their respective names.

Initiating the library

Once the library is properly linked to your page, an instance can be finally created. Please keep in mind that you can create and manage multiple instances of Storm Library at a time. Each instance requires a valid configuration object in order to work properly. Initialization will look different depending on picked JavaScript format.

  1. IIFE
                                    
    const storm = stormLibrary(config);
                                
  2. ESM
                                    
    import {StormLibrary} from "../../dist/esm/index.js";
    const storm = new StormLibrary(config);
                                
  3. UMD
                                    
    const storm = stormLibrary.create(config);
                                
  4. AMD

    RequireJS is used to load the module

                                    
    requirejs(['../../dist/amd/index'], function (storm) {
    
        const stormInstance = new storm.create(config);
    
    });