Skip to content

Commit a6d0d2a

Browse files
hkleungaitargos
authored andcommitted
doc: add missing options.info for BrotliOptions
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]>
1 parent 510872a commit a6d0d2a

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

doc/api/zlib.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -833,6 +833,7 @@ Each Brotli-based class takes an `options` object. All options are optional.
833833
* `params` {Object} Key-value object containing indexed [Brotli parameters][].
834834
* `maxOutputLength` {integer} Limits output size when using
835835
[convenience methods][]. **Default:** [`buffer.kMaxLength`][]
836+
* `info` {boolean} If `true`, returns an object with `buffer` and `engine`. **Default:** `false`
836837

837838
For example:
838839

0 commit comments

Comments
 (0)