Skip to content

Commit d001aa4

Browse files
committed
Docs: Add a reference for miniz.new_reader_memory
Pending review; keep this open as a reminder and merge after the next release was published.
1 parent f5693d9 commit d001aa4

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/references/api/bindings/miniz.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Applies [INFLATE](https://en.wikipedia.org/wiki/Deflate#Decoder/decompressor) to
8585

8686
## ZipFileReader
8787

88-
Created by [new_reader](#new_reader). You can use this to get information about the files within a ZIP archive or to extract them (in-memory).
88+
Created by [new_reader](#new_reader) or [new_reader_memory](#new_reader_memory). You can use this to get information about the files within a ZIP archive or to extract them (in-memory).
8989

9090
### extract
9191

@@ -389,6 +389,20 @@ Creates a new ZIP file reader for the given `fileSystemPath`. The `flags` passed
389389
</Returns>
390390
</Function>
391391

392+
### new_reader_memory
393+
394+
Creates a new ZIP file reader for the given `fileContents`. The `flags` passed to `miniz` can control the way that the archive is read.
395+
396+
<Function>
397+
<Parameters>
398+
<Parameter name="fileContents" type="string"/>
399+
<Parameter name="flags" type="number" optional/>
400+
</Parameters>
401+
<Returns>
402+
<Return name="reader" type="ZipFileReader"/>
403+
</Returns>
404+
</Function>
405+
392406
### new_writer
393407

394408
Creates a new ZIP file writer for the given `fileSystemPath`. The `flags` passed to `miniz` can control the way that the archive is written.

0 commit comments

Comments
 (0)