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

Update createNodeMiddleware() documentation #1089

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

arnitdo
Copy link

@arnitdo arnitdo commented Jan 8, 2025

Update createNodeMiddleware() - path option documentation, to reflect exact setting of value for custom routing options


Before the change?

  • Documentation does not fully reflect the correct behavior of path in createNodeMiddleware()

After the change?

  • Documentation updated, informing users that setting the path value to exactly "/" enables the created middleware to be used as a handler

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features) [No Changes]
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

Update `createNodeMiddleware()` - `path` option documentation, to reflect exact setting of value for custom routing options
Copy link
Contributor

github-actions bot commented Jan 8, 2025

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

@arnitdo
Copy link
Author

arnitdo commented Jan 8, 2025

Had to dig into the source code for this exact behavior, since not everyone is running http.createServer() usually - the generated middleware can technically be used with Express.js as well

@wolfy1339 wolfy1339 added the Type: Documentation Improvements or additions to documentation label Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

2 participants