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

feat(event): add default stringify with method and url for better dx #493

Merged
merged 2 commits into from
Aug 7, 2023

Conversation

pi0
Copy link
Member

@pi0 pi0 commented Aug 7, 2023

πŸ”— Linked issue

❓ 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

Using console.log(event) or directly returning it, leads to a complex and unreadable output like this:

image

This PR makes it stringified with method and FULL URL:

[PATCH] http://127.0.0.1:80/test

Note: toJSON is also usually expected to return a string and used by JSON.stringify (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toJSON)

πŸ“ Checklist

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

@codecov
Copy link

codecov bot commented Aug 7, 2023

Codecov Report

Merging #493 (b075926) into main (7e95702) will decrease coverage by 0.10%.
The diff coverage is 44.44%.

❗ Current head b075926 differs from pull request most recent head 6b52625. Consider uploading reports for the commit 6b52625 to get more accurate results

@@            Coverage Diff             @@
##             main     #493      +/-   ##
==========================================
- Coverage   82.34%   82.25%   -0.10%     
==========================================
  Files          31       31              
  Lines        3473     3482       +9     
  Branches      516      516              
==========================================
+ Hits         2860     2864       +4     
- Misses        613      618       +5     
Files Changed Coverage Ξ”
src/event/event.ts 88.00% <44.44%> (-2.37%) ⬇️

@pi0 pi0 merged commit 6c14ff9 into main Aug 7, 2023
4 checks passed
@pi0 pi0 deleted the feat/event-stringify branch August 7, 2023 08:38
@pi0 pi0 mentioned this pull request Aug 14, 2023
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.

None yet

1 participant