Skip to content

fix import path for github-script in README #495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix import path for github-script in README #495

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this not need to match the installed dependency above?

npm i -D @types/github-script@github:actions/github-script

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

ref: microsoft/TypeScript#16472

export default async ({ core, context }) => {
core.debug("Running something at the moment");
return context.actor;
Expand Down