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.

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

docs: improve jsdocs #574

Merged
merged 9 commits into from
Nov 20, 2023
Merged

docs: improve jsdocs #574

merged 9 commits into from
Nov 20, 2023

Conversation

TheAlexLichter
Copy link
Member

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Add some more JSDocs for methods πŸ‘πŸ»

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

Copy link

codecov bot commented Nov 12, 2023

Codecov Report

Merging #574 (092fec5) into main (7a8209b) will increase coverage by 0.38%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #574      +/-   ##
==========================================
+ Coverage   83.83%   84.22%   +0.38%     
==========================================
  Files          31       31              
  Lines        3563     3651      +88     
  Branches      543      543              
==========================================
+ Hits         2987     3075      +88     
  Misses        576      576              
Files Coverage Ξ”
src/event/event.ts 87.94% <100.00%> (+1.22%) ⬆️
src/event/utils.ts 59.77% <100.00%> (+1.15%) ⬆️
src/utils/body.ts 95.45% <100.00%> (+0.88%) ⬆️
src/utils/internal/object.ts 86.66% <100.00%> (+11.66%) ⬆️
src/utils/internal/validate.ts 95.45% <100.00%> (+1.01%) ⬆️
src/utils/route.ts 100.00% <100.00%> (ΓΈ)

return await toWebRequest(event).formData();
}

/**
* Captures a stream from a request.
Copy link
Member Author

Choose a reason for hiding this comment

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

It'd be great to have a better definition what exactly a "web request" is for people not aware that there are various web APIs ☺️

Copy link
Member

Choose a reason for hiding this comment

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

Surely! Will keep in mind for when having official docs to explain

@pi0 pi0 changed the title chore: add missing jsdocs docs: improve jsdocs Nov 20, 2023
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

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

Thanks ❀️

@pi0 pi0 merged commit c67121d into main Nov 20, 2023
6 checks passed
@pi0 pi0 deleted the feat/docs branch November 20, 2023 02:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants