refactor(http): improve eTag() return type for string and Uint8Array inputs
#5571
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5571 +/- ##
==========================================
- Coverage 96.49% 96.11% -0.38%
==========================================
Files 465 465
Lines 37772 37766 -6
Branches 5580 5549 -31
==========================================
- Hits 36447 36300 -147
- Misses 1283 1424 +141
Partials 42 42 ☔ View full report in Codecov by Sentry. |
iuioiua
suggested changes
Jul 30, 2024
http/etag_test.ts
Outdated
There was a problem hiding this comment.
Good to see @std/testing/types being used to test overload signatures. We should probably do this more throughout the codebase.
http/etag.ts
Outdated
Comment on lines
124
to
126
| * Calculate an ETag for an entity. When the entity is a specific set of data | ||
| * it will be fingerprinted as a "strong" tag, otherwise if it is just file | ||
| * information, it will be calculated as a weak tag. |
There was a problem hiding this comment.
We should update the descriptions to orient themselves to their respective overloads.
|
I'd also change the title to something like "Improve overloads for |
kt3k
changed the title
kt3k
changed the title
eTag return type for string and Uint8Array inputs
iuioiua
approved these changes
Jul 30, 2024
http/etag.ts
Outdated
| * Calculate an ETag for an entity. When the entity is a specific set of data | ||
| * it will be fingerprinted as a "strong" tag, otherwise if it is just file | ||
| * information, it will be calculated as a weak tag. | ||
| * Calculate an ETag for string or Uint8Array entities. This returns a strong tag. |
There was a problem hiding this comment.
Can you please clarify what you mean by "strong tag"?
iuioiua
approved these changes
Jul 30, 2024
iuioiua
changed the title
eTag return type for string and Uint8Array inputseTag return type for string and Uint8Array inputs
iuioiua
changed the title
eTag return type for string and Uint8Array inputseTag() return type for string and Uint8Array inputs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not completely sure this is a breaking change, but this PR improves the return type of
eTagfunction. Now it returnsPromise<string>if the input isstringorUint8Array.related #5217