rocket-launch-live-client 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,6 +1,22 @@
1
1
  import RLLClient from "./Client";
2
2
  import { RLLClientOptions } from "./types/application";
3
- declare const _default: {
4
- rllc: (apiKey: string, options?: RLLClientOptions) => RLLClient;
5
- };
6
- export default _default;
3
+ /**
4
+ * Generate a RocketLaunch.Live client
5
+ *
6
+ * @public
7
+ * @function
8
+ *
9
+ * @param {string} apiKey - Your RocketLaunch.Live API Key
10
+ * @param {Object} [options] - Optional Client Configuration options
11
+ * @param {boolean} options.keyInQueryParams - Set to true to send your API Key via Query parameters instead of Authorization Header (not recommended)
12
+ *
13
+ * @returns {RLLCLient}
14
+ *
15
+ * @example
16
+ *
17
+ * const MY_KEY = process.env.ROCKETLAUNCH_LIVE_API_KEY
18
+ *
19
+ * const client = clientGenerator(MY_KEY, { keyInQueryParams: true })
20
+ */
21
+ declare const rllc: (apiKey: string, options?: RLLClientOptions) => RLLClient;
22
+ export { rllc };
package/dist/index.js CHANGED
@@ -1,5 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.rllc = void 0;
3
4
  var Client_1 = require("./Client");
4
5
  /**
5
6
  * Generate a RocketLaunch.Live client
@@ -22,5 +23,5 @@ var Client_1 = require("./Client");
22
23
  var rllc = function (apiKey, options) {
23
24
  return new Client_1.default(apiKey, options);
24
25
  };
25
- exports.default = { rllc: rllc };
26
+ exports.rllc = rllc;
26
27
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +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"}
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;AAExB,oBAAI"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rocket-launch-live-client",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "A Node.JS client for interacting with the RocketLaunch.Live API",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {