From 38274728f6a4c2796b7c2384a8da1e041c76edf4 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Fri, 20 Nov 2015 11:10:33 -0800 Subject: [PATCH] [Workers] Update JSDoc ...per review feedback, nasa/openmctweb#309 --- platform/execution/src/WorkerService.js | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/platform/execution/src/WorkerService.js b/platform/execution/src/WorkerService.js index 1e143301da..e4c2ec6a66 100644 --- a/platform/execution/src/WorkerService.js +++ b/platform/execution/src/WorkerService.js @@ -65,8 +65,12 @@ define( * that has been registered under the `workers` category * of extension. * + * This will return either a Worker or a SharedWorker, + * depending on whether a `shared` flag has been specified + * on the the extension definition for the referenced worker. + * * @param {string} key symbolic identifier for the worker - * @returns {Worker} the running Worker + * @returns {Worker | SharedWorker} the running Worker */ WorkerService.prototype.run = function (key) { var scriptUrl = this.workerUrls[key],