Skip to content

Commit d00ea1d

Browse files
committed
Docs: Mention different use cases for miniz readers
1 parent 4dcc56c commit d00ea1d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/references/api/bindings/miniz.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ Creates a new [Inflator](#inflator) object and returns a `userdata` reference to
377377

378378
### new_reader
379379

380-
Creates a new ZIP file reader for the given `fileSystemPath`. The `flags` passed to `miniz` can control the way that the archive is read.
380+
Creates a new ZIP file reader for the given `fileSystemPath`. The `flags` passed to `miniz` can control the way that the archive is read. This method will automatically load the ZIP file from disk and attempt to decode it.
381381

382382
:::info
383383
This function is suitable if loading the entire file into memory is acceptable. Use a [deflator](#deflator) for streaming.
@@ -395,7 +395,7 @@ This function is suitable if loading the entire file into memory is acceptable.
395395

396396
### new_reader_memory
397397

398-
Creates a new ZIP file reader for the given `fileContents`. The `flags` passed to `miniz` can control the way that the archive is read.
398+
Creates a new ZIP file reader for the given `fileContents`. The `flags` passed to `miniz` can control the way that the archive is read. You must handle reading the file from disk yourself, however you see fit.
399399

400400
:::info
401401
This function is suitable if loading the entire file into memory is acceptable. Use a [deflator](#deflator) for streaming.

0 commit comments

Comments
 (0)