Skip to content

Commit 4dcc56c

Browse files
committed
Docs: Add info blocks to the miniz reader reference
1 parent d001aa4 commit 4dcc56c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/references/api/bindings/miniz.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,10 @@ Creates a new [Inflator](#inflator) object and returns a `userdata` reference to
379379

380380
Creates a new ZIP file reader for the given `fileSystemPath`. The `flags` passed to `miniz` can control the way that the archive is read.
381381

382+
:::info
383+
This function is suitable if loading the entire file into memory is acceptable. Use a [deflator](#deflator) for streaming.
384+
:::
385+
382386
<Function>
383387
<Parameters>
384388
<Parameter name="fileSystemPath" type="string"/>
@@ -393,6 +397,10 @@ Creates a new ZIP file reader for the given `fileSystemPath`. The `flags` passed
393397

394398
Creates a new ZIP file reader for the given `fileContents`. The `flags` passed to `miniz` can control the way that the archive is read.
395399

400+
:::info
401+
This function is suitable if loading the entire file into memory is acceptable. Use a [deflator](#deflator) for streaming.
402+
:::
403+
396404
<Function>
397405
<Parameters>
398406
<Parameter name="fileContents" type="string"/>

0 commit comments

Comments
 (0)