docs(eyes-sdk-core): update JSDoc and return type for deleteBatchSess…

…ions
astappiev · Sep 17, 2019 · af38cfe · af38cfe
1 parent 0728e08
commit af38cfe
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/packages/eyes-sdk-core/lib/server/ServerConnector.js b/packages/eyes-sdk-core/lib/server/ServerConnector.js
@@ -338,10 +338,10 @@ class ServerConnector {
  }
 
  /**
- * Stops the running session.
+ * Stops the running batch sessions.
  *
- * @param {string} batchId - The running session to be stopped.
- * @return {Promise<TestResults>} - TestResults object for the stopped running session
+ * @param {string} batchId - The batchId to be stopped.
+ * @return {Promise<void>}
  */
  async deleteBatchSessions(batchId) {
  ArgumentGuard.notNull(batchId, 'batchId');
@@ -356,6 +356,7 @@ class ServerConnector {
  const validStatusCodes = [HTTP_STATUS_CODES.OK];
  if (validStatusCodes.includes(response.status)) {
  this._logger.verbose('ServerConnector.deleteBatchSessions - delete succeeded');
+ return;
  }
 
  throw new Error(`ServerConnector.deleteBatchSessions - unexpected status (${response.statusText})`);