-
Notifications
You must be signed in to change notification settings - Fork 4
Fix errors in JSDoc typings #61
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #61 +/- ##
=======================================
Coverage 96.92% 96.92%
=======================================
Files 16 16
Lines 749 749
Branches 135 133 -2
=======================================
Hits 726 726
Misses 22 22
Partials 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
5c7724f to
c2b4ee3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request focuses on fixing JSDoc typings and aligning transport class constructor signatures across the codebase.
- Corrected JSDoc type annotations by replacing int/bool with number/boolean and more precise function signature annotations.
- Removed the allowInMemoryBuffer parameter from HTTP, WS, and Dummy transport constructors.
- Updated version numbers in constants and package.json.
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/trap.js | Updated JSDoc annotations and modified the HTTP transport instantiation to remove the buffer parameter. |
| src/transport/ws.js | Removed the allowInMemoryBuffer parameter from the constructor for consistency. |
| src/transport/http.js | Eliminated the allowInMemoryBuffer parameter in the HTTP transport constructor. |
| src/transport/dummy.js | Simplified the Dummy transport constructor by removing the allowInMemoryBuffer parameter. |
| src/constants.js | Bumped package version from 1.0.21 to 1.0.22. |
| package.json | Updated version number to match constants. |
Comments suppressed due to low confidence (4)
src/trap.js:72
- The removal of the buffer parameter in the HTTP constructor call should be double-checked to ensure it aligns with the intended behavior across the codebase.
transport: new HTTP(this._metadata),
src/transport/ws.js:13
- Removing the allowInMemoryBuffer parameter aligns with updates across transport classes; ensure that all invocations of this constructor are updated accordingly.
constructor(metadata, logger) {
src/transport/http.js:15
- The removal of the allowInMemoryBuffer parameter simplifies the constructor; ensure that all consumers of the HTTP class are updated to match the new signature.
constructor(metadata) {
src/transport/dummy.js:13
- Removing the allowInMemoryBuffer parameter in Dummy is consistent with other transport classes; verify that this change does not affect the buffering behavior where it is used.
constructor(metadata) {
No description provided.