Skip to content

Commit 920a4e8

Browse files
jsweep: improve type annotations in add_reviewer.cjs (#26371)
1 parent f3831d8 commit 920a4e8

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

actions/setup/js/add_reviewer.cjs

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,18 @@
33

44
/**
55
* @typedef {import('./types/handler-factory').HandlerFactoryFunction} HandlerFactoryFunction
6+
* @typedef {import('./types/handler-factory').HandlerConfig} HandlerConfig
7+
* @typedef {import('./types/handler-factory').ResolvedTemporaryIds} ResolvedTemporaryIds
8+
* @typedef {import('./types/handler-factory').HandlerResult} HandlerResult
69
*/
710

11+
/**
12+
* @typedef {{ reviewers?: Array<string|null|undefined|false>, pull_request_number?: number|string }} AddReviewerMessage
13+
*/
14+
15+
/** @type {string} Safe output type handled by this module */
16+
const HANDLER_TYPE = "add_reviewer";
17+
818
const { processItems } = require("./safe_output_processor.cjs");
919
const { getErrorMessage } = require("./error_helpers.cjs");
1020
const { getPullRequestNumber } = require("./pr_helpers.cjs");
@@ -32,9 +42,9 @@ async function main(config = {}) {
3242
let processedCount = 0;
3343

3444
/**
35-
* @param {Object} message - The add_reviewer message to process
36-
* @param {Object} resolvedTemporaryIds - Map of temporary IDs to {repo, number}
37-
* @returns {Promise<Object>} Result with success/error status
45+
* @param {AddReviewerMessage} message - The add_reviewer message to process
46+
* @param {ResolvedTemporaryIds} resolvedTemporaryIds - Map of temporary IDs to {repo, number}
47+
* @returns {Promise<HandlerResult>} Result with success/error status
3848
*/
3949
return async function handleAddReviewer(message, resolvedTemporaryIds) {
4050
if (processedCount >= maxCount) {

0 commit comments

Comments
 (0)