Explicitly mention surrounding by try/catch in JSDoc

This commit is contained in:
Henry Mercer
2022-11-29 16:29:27 +00:00
parent 00a3c456fb
commit e0dec83cfc
3 changed files with 19 additions and 4 deletions

View File

@@ -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
*/