@osaas/client-core - npm Package Compare versions

Comparing version 0.5.1 to 0.6.0

lib/core.d.ts

@@ -12,2 +12,3 @@ import { Context, Service } from './context';
  * Create a new instance of a service in Open Source Cloud
+ * @memberof module:@osaas/client-core
  * @param {Context} context - Open Source Cloud configuration context
@@ -29,2 +30,3 @@ * @param {string} serviceId - Service identifier. The service identifier is {github-organization}-{github-repo}
  * Remove an instance of a service in Open Source Cloud
+ * @memberof module:@osaas/client-core
  * @param {Context} context - Open Source Cloud configuration context
@@ -43,2 +45,3 @@ * @param {string} serviceId - The service identifier
  * Retrieve an instance of a service in Open Source Cloud
+ * @memberof module:@osaas/client-core
  * @param {Context} context - Open Source Cloud configuration context
@@ -53,2 +56,3 @@ * @param {string} serviceId - The service identifier
  * List all instances of a service in Open Source Cloud
+ * @memberof module:@osaas/client-core
  * @param {Context} context - Open Source Cloud configuration context
@@ -55,0 +59,0 @@ * @param {string} serviceId - The service identifier

lib/core.js

@@ -31,2 +31,3 @@ "use strict";
  * Create a new instance of a service in Open Source Cloud
+ * @memberof module:@osaas/client-core
  * @param {Context} context - Open Source Cloud configuration context
@@ -61,2 +62,3 @@ * @param {string} serviceId - Service identifier. The service identifier is {github-organization}-{github-repo}
  * Remove an instance of a service in Open Source Cloud
+ * @memberof module:@osaas/client-core
  * @param {Context} context - Open Source Cloud configuration context
@@ -86,2 +88,3 @@ * @param {string} serviceId - The service identifier
  * Retrieve an instance of a service in Open Source Cloud
+ * @memberof module:@osaas/client-core
  * @param {Context} context - Open Source Cloud configuration context
@@ -114,2 +117,3 @@ * @param {string} serviceId - The service identifier
  * List all instances of a service in Open Source Cloud
+ * @memberof module:@osaas/client-core
  * @param {Context} context - Open Source Cloud configuration context
@@ -116,0 +120,0 @@ * @param {string} serviceId - The service identifier

lib/index.d.ts

@@ -0,1 +1,2 @@
+/** @module @osaas/client-core */
 export { Log } from './log';
@@ -2,0 +3,0 @@ export { createFetch } from './fetch';

lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.waitForJobToComplete = exports.listJobs = exports.getJob = exports.removeJob = exports.createJob = exports.listInstances = exports.getInstance = exports.removeInstance = exports.createInstance = exports.Context = exports.createFetch = exports.Log = void 0;
+/** @module @osaas/client-core */
 var log_1 = require("./log");
@@ -5,0 +6,0 @@ Object.defineProperty(exports, "Log", { enumerable: true, get: function () { return log_1.Log; } });

lib/job.d.ts

@@ -10,2 +10,3 @@ import { Context } from './context';
  * Create a new service job in Open Source Cloud
+ * @memberof module:@osaas/client-core
  * @param {Context} context - Open Source Cloud configuration context
@@ -34,6 +35,37 @@ * @param {string} serviceId - Service identifier. The service identifier is {github-organization}-{github-repo}
 export declare function createJob(context: Context, serviceId: string, token: string, body: any): Promise<any>;
+/**
+ * Remove a service job in Open Source Cloud
+ * @memberof module:@osaas/client-core
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} serviceId - Service identifier. The service identifier is {github-organization}-{github-repo}
+ * @param {string} name - Name of service job to remove
+ * @param {string} token - Service access token
+ */
 export declare function removeJob(context: Context, serviceId: string, name: string, token: string): Promise<void>;
+/**
+ * Get a service job in Open Source Cloud
+ * @memberof module:@osaas/client-core
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} serviceId - Service identifier. The service identifier is {github-organization}-{github-repo}
+ * @param {string} name - Name of service job to read
+ * @param {string} token - Service access token
+ */
 export declare function getJob(context: Context, serviceId: string, name: string, token: string): Promise<any>;
+/**
+ * List service jobs in Open Source Cloud
+ * @memberof module:@osaas/client-core
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} serviceId - Service identifier. The service identifier is {github-organization}-{github-repo}
+ * @param {string} token - Service access token
+ */
 export declare function listJobs(context: Context, serviceId: string, token: string): Promise<any>;
+/**
+ * Wait for a service job to complete
+ * @memberof module:@osaas/client-core
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} serviceId - Service identifier. The service identifier is {github-organization}-{github-repo}
+ * @param {string} name - Name of service job to wait for
+ * @param {string} token - Service access token
+ */
 export declare function waitForJobToComplete(context: Context, serviceId: string, name: string, token: string): Promise<void>;
 //# sourceMappingURL=job.d.ts.map

lib/job.js

@@ -15,2 +15,3 @@ "use strict";
  * Create a new service job in Open Source Cloud
+ * @memberof module:@osaas/client-core
  * @param {Context} context - Open Source Cloud configuration context
@@ -46,2 +47,10 @@ * @param {string} serviceId - Service identifier. The service identifier is {github-organization}-{github-repo}
 exports.createJob = createJob;
+/**
+ * Remove a service job in Open Source Cloud
+ * @memberof module:@osaas/client-core
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} serviceId - Service identifier. The service identifier is {github-organization}-{github-repo}
+ * @param {string} name - Name of service job to remove
+ * @param {string} token - Service access token
+ */
 async function removeJob(context, serviceId, name, token) {
@@ -55,2 +64,10 @@ const service = await (0, core_1.getService)(context, serviceId);
 exports.removeJob = removeJob;
+/**
+ * Get a service job in Open Source Cloud
+ * @memberof module:@osaas/client-core
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} serviceId - Service identifier. The service identifier is {github-organization}-{github-repo}
+ * @param {string} name - Name of service job to read
+ * @param {string} token - Service access token
+ */
 async function getJob(context, serviceId, name, token) {
@@ -64,2 +81,9 @@ const service = await (0, core_1.getService)(context, serviceId);
 exports.getJob = getJob;
+/**
+ * List service jobs in Open Source Cloud
+ * @memberof module:@osaas/client-core
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} serviceId - Service identifier. The service identifier is {github-organization}-{github-repo}
+ * @param {string} token - Service access token
+ */
 async function listJobs(context, serviceId, token) {
@@ -73,2 +97,10 @@ const service = await (0, core_1.getService)(context, serviceId);
 exports.listJobs = listJobs;
+/**
+ * Wait for a service job to complete
+ * @memberof module:@osaas/client-core
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} serviceId - Service identifier. The service identifier is {github-organization}-{github-repo}
+ * @param {string} name - Name of service job to wait for
+ * @param {string} token - Service access token
+ */
 async function waitForJobToComplete(context, serviceId, name, token) {
@@ -75,0 +107,0 @@ for (const _ of Array(MAX_ITER)) {

package.json

 {
   "name": "@osaas/client-core",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "Open Source Cloud Client SDK core library",
@@ -34,3 +34,3 @@ "author": "Eyevinn Technology <[e-mail]>",
   },
-  "gitHead": "1cd9bcf9e53033687345cbffa58d61853ade3a1f"
+  "gitHead": "0d54f545a51a26df68290fc3a3bcfce2ce2851aa"
 }

No alert changes

Improved metrics

Total package byte prevSize

43829

increased by8.72%

Lines of code

652

increased by12.8%

No dependency changes