Skip to content

docs: fix description ofhandleCors's return value #1167

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
Merged
merged 2 commits into from
Sep 29, 2025
Merged

docs: fix description ofhandleCors's return value #1167

merged 2 commits into from
Sep 29, 2025

Conversation

kricsleo
Copy link
Member

resolves #1166

(Also wondering if we can revert the v1's boolean return value to minimize breaking changes 🤔)

@kricsleo kricsleo requested a review from pi0 as a code owner July 23, 2025 03:07
@codecov Codecov
Copy link

codecov bot commented Jul 23, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@pi0
Copy link
Member

pi0 commented Jul 23, 2025 •
edited
Loading

Yes i think might make sense for v1 (also v2) to avoid returning falsy like "" value.

Do you know why we did that? (i have to check history) but seems your suggestion for avoid that is more sensable than asking for === false check.

@kricsleo
Copy link
Member Author

kricsleo commented Jul 23, 2025 •
edited
Loading

I think this change might be unintentional. Firstly, it was return true when handled, then it was changed to return noContent(...). From this point on, the falsy check no longer works as expected since noContent would return an empty string.

@randName
Copy link
Contributor

I wonder if noContent should just construct a proper Response instead of returning an empty string, then the original check should work

@randName randName mentioned this pull request Jul 31, 2025
Merged
@kricsleo
Copy link
Member Author

kricsleo commented Aug 5, 2025 •
edited
Loading

noContent should just construct a proper Response

Yeah, I agree with this; it would be more usable. 👍
This PR can be safely closed if #1177 is merged.

pi0
pi0 approved these changes Sep 29, 2025
View reviewed changes
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@pi0 pi0 merged commit 5409608 into h3js:main Sep 29, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pi0 pi0 pi0 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

handleCors() returns falsy sentinel (""), conflicting with example usage.

3 participants

@kricsleo @pi0 @randName