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

Jump to bottom

Improve jsdocs / add PR coverage report #2

Merged
merged 2 commits into from
May 31, 2024
Merged

Improve jsdocs / add PR coverage report #2

merged 2 commits into from
May 31, 2024

Conversation

huntharo
Copy link
Contributor

@huntharo huntharo commented May 31, 2024 •
edited
Loading

  • Repeat class doc on constructor since typically only the constructor is looked at
  • Repeat constructor param docs on each param so they show up on tooltip
  • Give examples of where to send items in the writer function
  • Clarify that the size limit is not to be exceeded but the count limit can be called at exactly the limit
  • Remove TResult that was not really a template param
  • Add code coverage report on PRs

@github-actions GitHub Actions
Copy link

📊 Node.js Code Coverage Report

File Lines Lines Hit / Found Uncovered Lines Branches
src/chunker.ts ✅ 99.5% 183 / 184 1 94.4%
Overall ✅ 99.5% 183 / 184 1 94.4%

@huntharo huntharo changed the title Improve jsdocs Improve jsdocs / add PR coverage report May 31, 2024
@huntharo huntharo merged commit 69f994d into main May 31, 2024
3 checks passed
@huntharo huntharo deleted the update-jsdocs branch May 31, 2024 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@huntharo