Skip to content

Commit 28f9b43

Browse files
hkleungaiaduh95
authored andcommitted
doc: add missing options.info for ZstdOptions
Source code of `class Zstd` calls ctor of parent `ZlibBase` via `super()` 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 `BrotliOptions`, since these two changes potentially need to be backported to different minimum versions. PR-URL: #58360 Reviewed-By: Antoine du Hamel <[email protected]>
1 parent e19496d commit 28f9b43

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
@@ -1081,6 +1081,7 @@ Each Zstd-based class takes an `options` object. All options are optional.
10811081
* `params` {Object} Key-value object containing indexed [Zstd parameters][].
10821082
* `maxOutputLength` {integer} Limits output size when using
10831083
[convenience methods][]. **Default:** [`buffer.kMaxLength`][]
1084+
* `info` {boolean} If `true`, returns an object with `buffer` and `engine`. **Default:** `false`
10841085

10851086
For example:
10861087

0 commit comments

Comments
 (0)