Update Bun.serve() types documentation to match the exact values from bun.d.ts
#10420
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
docs/api/http.md
Outdated
| maxRequestBodySize?: number; | ||
| port?: string | number; | ||
| reusePort?: boolean; | ||
| serverNames?: Record<string, TLSOptions>; // Server Name Indication (SNI) / TLS virtual hosts |
There was a problem hiding this comment.
serverNames is incorrect, it does not exist in the codebase
tls can optionally be an array of the object type or just the object type
There was a problem hiding this comment.
Hmm, this must have changed since I filed this; this is how it was yesterday. Thanks for the heads up. I just pulled main now and the types appear to be different. I'll do a once over on all of them to make sure they're right.
There was a problem hiding this comment.
Actually come to think of it I was checking types from bun-types version 1.1.4 not main. I'm checking main now.
|
Bump. Pretty sure this is ready to go. |
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.
What does this PR do?
I've been spending a lot of time looking at
Bun.serve()and its types lately, and I noticed the website documentation documenting the types are out of date. This PR attempts to bring them in line with the current published types inbun.d.ts.I matched the types exactly, added missing keys, and reordered the keys in each object to be in alphabetical order so it's a bit easier to find what you're looking for.
Formatted with Prettier.