Skip to content

Conversation

@thexeos
Copy link
Contributor

@thexeos thexeos commented Apr 7, 2025

What does this PR do?

This adds missing static method declarations for S3Client. Preference is given to instance methods, so JSDoc will only show for those and not for static ones.

  • Documentation or TypeScript types

Closes #18818

@RiskyMH RiskyMH added the types An issue with TypeScript types label Apr 7, 2025
@alii
Copy link
Member

alii commented Apr 7, 2025

Thanks for the PR - I actually didn't know we supported these until now😅

Looks like we have some other supported static methods. Would be great if you could add these also, as it's within scope of this PR

CleanShot 2025-04-07 at 02 29 39@2x

Once that's added I'll give this an approval and we can get it merged. Thanks again

@alii alii self-requested a review April 7, 2025 01:32
@thexeos
Copy link
Contributor Author

thexeos commented Apr 7, 2025

I keep forgetting that TS is elegant. The missing JSDocs are now back.

Copy link
Member

@alii alii left a comment

Choose a reason for hiding this comment

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

Just one thing!

@thexeos thexeos requested a review from alii April 7, 2025 19:57
Copy link
Member

@alii alii left a comment

Choose a reason for hiding this comment

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

Some params got removed, we will be generating documentation soon
so would be nice to have those. The @examples are great, though, thanks for adding those.

@thexeos thexeos requested a review from alii April 8, 2025 02:11
Copy link
Member

@alii alii left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

@Jarred-Sumner Jarred-Sumner merged commit 7e03e5e into oven-sh:main Apr 14, 2025
7 of 8 checks passed
@thexeos thexeos deleted the fix-18818 branch April 14, 2025 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

types An issue with TypeScript types

Projects

None yet

Development

Successfully merging this pull request may close these issues.

S3Client static methods are not marked as such

4 participants