Explicitly mention surrounding by try/catch in JSDoc

lib/workflow.js

@@ -19,7 +19,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCheckoutPathInputOrThrow = exports.getUploadInputOrThrow = exports.getCategoryInputOrThrow = exports.getStepsCallingAction = exports.getWorkflowRunID = exports.getWorkflowPath = exports.getWorkflow = exports.formatWorkflowCause = exports.formatWorkflowErrors = exports.validateWorkflow = exports.getWorkflowErrors = exports.WorkflowErrors = exports.patternIsSuperset = void 0;
+exports.getCheckoutPathInputOrThrow = exports.getUploadInputOrThrow = exports.getCategoryInputOrThrow = exports.getWorkflowRunID = exports.getWorkflowPath = exports.getWorkflow = exports.formatWorkflowCause = exports.formatWorkflowErrors = exports.validateWorkflow = exports.getWorkflowErrors = exports.WorkflowErrors = exports.patternIsSuperset = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const core = __importStar(require("@actions/core"));
@@ -253,11 +253,12 @@ function getStepsCallingAction(job, actionName) {
     }
     return steps.filter((step) => { var _a; return (_a = step.uses) === null || _a === void 0 ? void 0 : _a.includes(actionName); });
 }
-exports.getStepsCallingAction = getStepsCallingAction;
 /**
  * Makes a best effort attempt to retrieve the value of a particular input with which
  * an Action in the workflow would be invoked.
  *
+ * Typically you'll want to wrap this function in a try/catch block and handle the error.
+ *
  * @returns the value of the input, or undefined if no such input is passed to the Action
  * @throws an error if the value of the input could not be determined, or we could not
  * determine that no such input is passed to the Action.
@@ -298,6 +299,8 @@ function getInputOrThrow(workflow, jobName, actionName, inputName, matrixVars) {
  * Makes a best effort attempt to retrieve the category input for the particular job,
  * given a set of matrix variables.
  *
+ * Typically you'll want to wrap this function in a try/catch block and handle the error.
+ *
  * @returns the category input, or undefined if the category input is not defined
  * @throws an error if the category input could not be determined
  */
@@ -309,6 +312,8 @@ exports.getCategoryInputOrThrow = getCategoryInputOrThrow;
  * Makes a best effort attempt to retrieve the upload input for the particular job,
  * given a set of matrix variables.
  *
+ * Typically you'll want to wrap this function in a try/catch block and handle the error.
+ *
  * @returns the upload input
  * @throws an error if the upload input could not be determined
  */
@@ -321,6 +326,8 @@ exports.getUploadInputOrThrow = getUploadInputOrThrow;
  * Makes a best effort attempt to retrieve the checkout_path input for the
  * particular job, given a set of matrix variables.
  *
+ * Typically you'll want to wrap this function in a try/catch block and handle the error.
+ *
  * @returns the checkout_path input
  * @throws an error if the checkout_path input could not be determined
  */

src/workflow.ts

@@ -293,7 +293,7 @@ export function getWorkflowRunID(): number {
   return workflowRunID;
 }
 
-export function getStepsCallingAction(
+function getStepsCallingAction(
   job: WorkflowJob,
   actionName: string
 ): WorkflowJobStep[] {
@@ -310,6 +310,8 @@ export function getStepsCallingAction(
  * Makes a best effort attempt to retrieve the value of a particular input with which
  * an Action in the workflow would be invoked.
  *
+ * Typically you'll want to wrap this function in a try/catch block and handle the error.
+ *
  * @returns the value of the input, or undefined if no such input is passed to the Action
  * @throws an error if the value of the input could not be determined, or we could not
  * determine that no such input is passed to the Action.
@@ -370,6 +372,8 @@ function getInputOrThrow(
  * Makes a best effort attempt to retrieve the category input for the particular job,
  * given a set of matrix variables.
  *
+ * Typically you'll want to wrap this function in a try/catch block and handle the error.
+ *
  * @returns the category input, or undefined if the category input is not defined
  * @throws an error if the category input could not be determined
  */
@@ -391,6 +395,8 @@ export function getCategoryInputOrThrow(
  * Makes a best effort attempt to retrieve the upload input for the particular job,
  * given a set of matrix variables.
  *
+ * Typically you'll want to wrap this function in a try/catch block and handle the error.
+ *
  * @returns the upload input
  * @throws an error if the upload input could not be determined
  */
@@ -414,6 +420,8 @@ export function getUploadInputOrThrow(
  * Makes a best effort attempt to retrieve the checkout_path input for the
  * particular job, given a set of matrix variables.
  *
+ * Typically you'll want to wrap this function in a try/catch block and handle the error.
+ *
  * @returns the checkout_path input
  * @throws an error if the checkout_path input could not be determined
  */