diff --git a/actions/setup/js/add_reviewer.cjs b/actions/setup/js/add_reviewer.cjs index 28b7660d77c..3d83903f80c 100644 --- a/actions/setup/js/add_reviewer.cjs +++ b/actions/setup/js/add_reviewer.cjs @@ -3,8 +3,18 @@ /** * @typedef {import('./types/handler-factory').HandlerFactoryFunction} HandlerFactoryFunction + * @typedef {import('./types/handler-factory').HandlerConfig} HandlerConfig + * @typedef {import('./types/handler-factory').ResolvedTemporaryIds} ResolvedTemporaryIds + * @typedef {import('./types/handler-factory').HandlerResult} HandlerResult */ +/** + * @typedef {{ reviewers?: Array, pull_request_number?: number|string }} AddReviewerMessage + */ + +/** @type {string} Safe output type handled by this module */ +const HANDLER_TYPE = "add_reviewer"; + const { processItems } = require("./safe_output_processor.cjs"); const { getErrorMessage } = require("./error_helpers.cjs"); const { getPullRequestNumber } = require("./pr_helpers.cjs"); @@ -32,9 +42,9 @@ async function main(config = {}) { let processedCount = 0; /** - * @param {Object} message - The add_reviewer message to process - * @param {Object} resolvedTemporaryIds - Map of temporary IDs to {repo, number} - * @returns {Promise} Result with success/error status + * @param {AddReviewerMessage} message - The add_reviewer message to process + * @param {ResolvedTemporaryIds} resolvedTemporaryIds - Map of temporary IDs to {repo, number} + * @returns {Promise} Result with success/error status */ return async function handleAddReviewer(message, resolvedTemporaryIds) { if (processedCount >= maxCount) {