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

chore: updated readme.md & JS Docs documentation in code #7

Merged
merged 2 commits into from
Feb 19, 2024
Merged

chore: updated readme.md & JS Docs documentation in code #7

merged 2 commits into from
Feb 19, 2024

Conversation

yashim-deriv
Copy link
Collaborator

Description

  • Updated readme.md for a basic overview of the project - overview, installation, usage examples, etc.
  • Updated missing JSDOC documentation in code

@github-actions GitHub Actions
Copy link

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 100% 532 / 532
🔵 Statements 100% 532 / 532
🔵 Functions 100% 14 / 14
🔵 Branches 92.15% 47 / 51
File Coverage
File Stmts % Branch % Funcs % Lines Uncovered Lines
Changed Files
src/utils/index.ts 100% 100% 100% 100%
src/utils/localstorage.utils.ts 100% 100% 100% 100%
src/utils/url.utils.ts 100% 81.81% 100% 100%
src/utils/websocket.utils.ts 100% 100% 100% 100%
Generated in workflow #6

@yashim-deriv yashim-deriv merged commit bcb7bec into master Feb 19, 2024
1 check passed
@yashim-deriv yashim-deriv deleted the add_jsdoc_to_missing_comments branch February 19, 2024 04:15
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
@yashim-deriv