Skip to content

Commit 4bbd026

Browse files
hkleungaitargos
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 <duhamelantoine1995@gmail.com>
1 parent a6d0d2a commit 4bbd026

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

10731074
For example:
10741075

0 commit comments

Comments
 (0)