doc: add missing options.info for BrotliOptions #58359
Merged
Conversation
This file contains hidden or 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
nodejs-github-bot
added
doc
Source code of `function Brotli()` calls ctor of parent `ZlibBase` via `ReflectApply()` By inspecting `opts` in `ZlibBase` ctor, we can see `opts?.info` is further used to determine the return shapes of `*Sync()` methods in children class. This information will need to be revealed in nodejs doc. This PR is separated from the one for `ZstdOptions`, since these two changes potentially need to be backported to different minimum versions.
hkleungai
force-pushed
the
doc-api-zlib-add-missing-BrotliOptions.info
branch
from
76511de to
dabc311
Compare
aduh95
approved these changes
May 28, 2025
aduh95
added
author ready
nodejs-github-bot
removed
the
commit-queue
|
Landed in e71a3ce |
targos
pushed a commit
that referenced
this pull request
May 31, 2025
Source code of `function Brotli()` calls ctor of parent `ZlibBase` via `ReflectApply()` By inspecting `opts` in `ZlibBase` ctor, we can see `opts?.info` is further used to determine the return shapes of `*Sync()` methods in children class. This information will need to be revealed in nodejs doc. This PR is separated from the one for `ZstdOptions`, since these two changes potentially need to be backported to different minimum versions. PR-URL: #58359 Reviewed-By: Antoine du Hamel <[email protected]>
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.
Source code of
function Brotli()calls ctor of parentZlibBaseviaReflectApply()By inspecting
optsinZlibBasector, we can seeopts?.infoisfurther used to determine the return shapes of
*Sync()methods inchildren class. This information will need to be revealed in nodejs doc.
This PR is separated from the one for
ZstdOptions, since these twochanges potentially need to be backported to different minimum versions.