Boilsquid/ch622/add typings files

.gitignore

@@ -102,3 +102,6 @@ dist
 
 # TernJS port file
 .tern-port
+
+# JetBrains
+.idea/

lib/index.js

@@ -3,6 +3,7 @@ const Config = require('./config');
 const { Crypto, Http } = require('./core');
 
 class EvervaultClient {
+
   constructor(apikey) {
     if (!Datatypes.isString(apikey)) {
       throw new errors.InitializationError('Api key must be a string');
@@ -12,6 +13,12 @@ class EvervaultClient {
     this.http = Http(this.config.http);
   }
 
+  /**
+   *
+   * @param {Object || String} data
+   * @param {Object} options
+   * @returns {Promise<Object || String>}
+   */
   async encrypt(data, options) {
     if (!Datatypes.isDefined(this._cageKey)) {
       const cageKeyResponse = await this.http.getCageKey();
@@ -23,11 +30,24 @@ class EvervaultClient {
     return await this.crypto.encrypt(this._cageKey, data, options || {});
   }
 
+  /**
+   *
+   * @param {String} cageName
+   * @param {Object || String} payload
+   * @returns {Promise<*>}
+   */
   async run(cageName, payload) {
     const response = await this.http.runCage(cageName, payload);
     return response.body
   }
 
+  /**
+   *
+   * @param {String} cageName
+   * @param {Object} data
+   * @param {Object} options
+   * @returns {Promise<*>}
+   */
   async encryptAndRun(cageName, data, options) {
     const payload = await this.encrypt(data, options);
     return await this.run(cageName, payload);