Skip to content

Commit 9ba31de

Browse files
committed
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.
1 parent 5984444 commit 9ba31de

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
@@ -1049,6 +1049,7 @@ Each Zstd-based class takes an `options` object. All options are optional.
10491049
* `params` {Object} Key-value object containing indexed [Zstd parameters][].
10501050
* `maxOutputLength` {integer} Limits output size when using
10511051
[convenience methods][]. **Default:** [`buffer.kMaxLength`][]
1052+
* `info` {boolean} (If `true`, returns an object with `buffer` and `engine`.)
10521053

10531054
For example:
10541055

0 commit comments

Comments
 (0)