Skip to content
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

noUnusedParameters: add note about underscore prefix exception #3178

Open
wants to merge 1 commit into
base: v2
Choose a base branch
from
+9 −0
Open

noUnusedParameters: add note about underscore prefix exception #3178

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
9 changes: 9 additions & 0 deletions packages/tsconfig-reference/copy/en/options/noUnusedParameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,12 @@ const createDefaultKeyboard = (modelID: number) => {
return { type: "keyboard", modelID: defaultModelID };
};
```

Parameters declaration with names starting with an underscore _ are exempt from the unused parameter checking. e.g.:

```ts twoslash
function returnNull(_a) {
Copy link
Member

Choose a reason for hiding this comment

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

This needs a type annotation to prevent the error: https://victorious-plant-05c166c10-3178.centralus.5.azurestaticapps.net/tsconfig/#noUnusedParameters

Copy link
Member

@jakebailey jakebailey Aug 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Also, set // @noUnusedParameters here. Best to copy the above example and just rename the parameter, actually (but without the @errors)

Copy link
Author

Choose a reason for hiding this comment

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

Will do!

// OK
return null;
}
```