Skip to content

Commit 9537d7e

Browse files
authored
Fix up the JSDoc for vararg parameters (#98)
1 parent ea37081 commit 9537d7e

File tree

3 files changed

+8
-21
lines changed

3 files changed

+8
-21
lines changed

package-lock.json

Lines changed: 0 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

renovate.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3-
"extends": ["config:recommended"]
3+
"extends": ["config:recommended"],
4+
"rangeStrategy": "replace"
45
}

src/ActRunner.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ export class ActRunner {
118118

119119
/**
120120
* Sets environment variables to use when invoking the given workflow.
121-
* @param {[string, string][]} envValues - environment variable values to use as env in the containers
121+
* @param {...[string, string]} envValues - environment variable values to use as env in the containers
122122
*/
123123
withEnvValues(...envValues: [string, string][]): ActRunner {
124124
envValues.forEach((entry) => this.envValues.set(entry[0], entry[1]));
@@ -136,7 +136,7 @@ export class ActRunner {
136136

137137
/**
138138
* Sets inputs values to use when invoking the given workflow.
139-
* @param {[string, string][]} inputsValues - action input to make available to actions
139+
* @param {...[string, string]} inputsValues - action input to make available to actions
140140
*/
141141
withInputsValues(...inputsValues: [string, string][]): ActRunner {
142142
inputsValues.forEach((entry) => this.inputsValues.set(entry[0], entry[1]));
@@ -154,7 +154,7 @@ export class ActRunner {
154154

155155
/**
156156
* Sets secrets values to use when invoking the given workflow.
157-
* @param {[string, string][]} secretsValues - secrets to make available to actions
157+
* @param {...[string, string]} secretsValues - secrets to make available to actions
158158
*/
159159
withSecretsValues(...secretsValues: [string, string][]): ActRunner {
160160
secretsValues.forEach((entry) =>
@@ -174,7 +174,7 @@ export class ActRunner {
174174

175175
/**
176176
* Sets variables values to use when invoking the given workflow.
177-
* @param {[string, string][]} variablesValues - secrets to make available to actions
177+
* @param {...[string, string]} variablesValues - secrets to make available to actions
178178
*/
179179
withVariablesValues(...variablesValues: [string, string][]): ActRunner {
180180
variablesValues.forEach((entry) =>
@@ -186,7 +186,7 @@ export class ActRunner {
186186
/**
187187
* Set matrix values to run the workflow with.
188188
* If undefined, all combinations specified in the workflow definition will be invoked.
189-
* @param {[string, anu][]} matrixValues - matrix values to run the workflow with
189+
* @param {...[string, any]} matrixValues - matrix values to run the workflow with
190190
* @returns
191191
*/
192192
withMatrix(...matrixValues: [string, any][]): ActRunner {
@@ -226,7 +226,7 @@ export class ActRunner {
226226

227227
/**
228228
* Arbitrary additional arguments to pass to the `act` execution.
229-
* @param {string[]} args - additional arguments to invoke `act` with
229+
* @param {...string} args - additional arguments to invoke `act` with
230230
*/
231231
withAdditionalArgs(...args: string[]): ActRunner {
232232
args.forEach((arg) => this.additionalArgs.push(arg));

0 commit comments

Comments
 (0)