Plugin Libraries

There are three types of third party libraries for all plugins: preconfigured, default, and plugin specific.
Preconfigured Libraries
Preconfigured libraries are libraries that have the same configuration for all plugins. These are included in an object this.pluginLibraries. The libraries included are:
​app - Express app (v4.16.2)
​toolsLib - HollaEx Tools Library
​loggerPlugin - Winston logger (v3.2.1)
Default Libraries
Default libraries are libraries that are already installed in the Kit itself. These can be imported using require. Please take a look at the Kit package.json file for all default libraries included. Some are:
​lodash - (v4.17.20)
​expressValidator - (v6.7.0)
​multer - (v1.4.2)
​moment - (v2.21.0)
​mathjs - (v3.20.2)
​bluebird - (v3.5.3)
​rp - Request promise (v4.2.2)
​uuid - (v3.2.1)
​umzug - (v2.3.0)
​sequelize - (v4.37.7)
​json2csv - (v4.5.4)
​flat - (v5.0.0)
​cron  - (v2.8.5)
​bcryptjs - (v2.4.3)
​validator - (v9.4.1)
​cors - (v2.8.5)
Plugin Specific Libraries
Plugin specific libraries are libraries that are not installed in the Kit but required for the plugin. These can be installed through the prescript.install object in the plugin configuration and imported using require. 
Please do not add any plugin specific libraries that are already included by default. It is possible a different version of the library can be installed which can cause some unexpected bugs.
To add a plugin specific library on installation, include the library name inside the install array in the  prescript object. To specify a version, include the @ symbol with the version desired (similar to how basic npm install works).
{
    ...
    prescript: {
        install: ['hello-world-npm']
    },
    ...
}

Overview

Basic Tutorial: Hello Exchange Plugin

Last modified 9mo ago

Copy link

On this page

Preconfigured Libraries

Default Libraries

Plugin Specific Libraries