You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/references/api/bindings/miniz.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -377,7 +377,7 @@ Creates a new [Inflator](#inflator) object and returns a `userdata` reference to
377
377
378
378
### new_reader
379
379
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.
381
381
382
382
:::info
383
383
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.
395
395
396
396
### new_reader_memory
397
397
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.
399
399
400
400
:::info
401
401
This function is suitable if loading the entire file into memory is acceptable. Use a [deflator](#deflator) for streaming.
0 commit comments