rocket-launch-live-client 0.1.3 → 0.1.5

package/dist/index.d.ts

@@ -1,6 +1,22 @@
 import RLLClient from "./Client";
 import { RLLClientOptions } from "./types/application";
-declare const _default: {
-    rllc: (apiKey: string, options?: RLLClientOptions) => RLLClient;
-};
-export default _default;
+/**
+ * Generate a RocketLaunch.Live client
+ *
+ * @public
+ * @function
+ *
+ * @param {string} apiKey - Your RocketLaunch.Live API Key
+ * @param {Object} [options] - Optional Client Configuration options
+ * @param {boolean} options.keyInQueryParams - Set to true to send your API Key via Query parameters instead of Authorization Header (not recommended)
+ *
+ * @returns {RLLCLient}
+ *
+ * @example
+ *
+ * const MY_KEY = process.env.ROCKETLAUNCH_LIVE_API_KEY
+ *
+ * const client = clientGenerator(MY_KEY, { keyInQueryParams: true })
+ */
+declare const rllc: (apiKey: string, options?: RLLClientOptions) => RLLClient;
+export { rllc };

package/dist/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.rllc = void 0;
 var Client_1 = require("./Client");
 /**
  * Generate a RocketLaunch.Live client
@@ -22,5 +23,5 @@ var Client_1 = require("./Client");
 var rllc = function (apiKey, options) {
     return new Client_1.default(apiKey, options);
 };
-exports.default = { rllc: rllc };
+exports.rllc = rllc;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,mCAAiC;AAGjC;;;;;;;;;;;;;;;;;GAiBG;AACH,IAAM,IAAI,GAAG,UAAC,MAAc,EAAE,OAA0B;IACtD,OAAA,IAAI,gBAAS,CAAC,MAAM,EAAE,OAAO,CAAC;AAA9B,CAA8B,CAAC;AAEjC,kBAAe,EAAE,IAAI,MAAA,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAiC;AAGjC;;;;;;;;;;;;;;;;;GAiBG;AACH,IAAM,IAAI,GAAG,UAAC,MAAc,EAAE,OAA0B;IACtD,OAAA,IAAI,gBAAS,CAAC,MAAM,EAAE,OAAO,CAAC;AAA9B,CAA8B,CAAC;AAExB,oBAAI"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rocket-launch-live-client",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "A Node.JS client for interacting with the RocketLaunch.Live API",
   "main": "dist/index.js",
   "scripts": {

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es5",
-    "module": "commonjs",
-    "sourceMap": true,
-    "outDir": "dist",
-    "declaration": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist", "src/test.ts"]
-}