fix import path for github-script in README #495
+1
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joshmgross
reviewed
Nov 1, 2024
| @@ -437,7 +437,7 @@ $ npm i -D @types/github-script@github:actions/github-script | |||
| And then add the `jsDoc` declaration to your script like this: | |||
| ```js | |||
| // @ts-check | |||
| /** @param {import('@types/github-script').AsyncFunctionArguments} AsyncFunctionArguments */ | |||
| /** @param {import('github-script').AsyncFunctionArguments} AsyncFunctionArguments */ | |||
There was a problem hiding this comment.
Does this not need to match the installed dependency above?
npm i -D @types/github-script@github:actions/github-scriptThere was a problem hiding this comment.
The @types packages are automatically mapped to the packages with @types stripped off.
And importing @types/github-script causes error TS6137. Rewriting to github-script resolves this issue.
invisiblepancake
approved these changes
Nov 2, 2024
invisiblepancake
approved these changes
Nov 2, 2024
invisiblepancake
approved these changes
Nov 2, 2024
invisiblepancake
approved these changes
Nov 2, 2024
| @@ -437,7 +437,7 @@ $ npm i -D @types/github-script@github:actions/github-script | |||
| And then add the `jsDoc` declaration to your script like this: | |||
| ```js | |||
| // @ts-check | |||
| /** @param {import('@types/github-script').AsyncFunctionArguments} AsyncFunctionArguments */ | |||
| /** @param {import('github-script').AsyncFunctionArguments} AsyncFunctionArguments */ | |||
invisiblepancake
approved these changes
Nov 2, 2024
TeriThetha
approved these changes
Nov 3, 2024
invisiblepancake
approved these changes
Nov 4, 2024
invisiblepancake
approved these changes
Nov 4, 2024
TeriThetha
approved these changes
Nov 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.