Skip to content

Commit 74b770e

Browse files
committed
Docs: Adjust the referenced miniz reader returns
There should be a standard way of denoting failure tuples, but right now there isn't. Maybe one day...
1 parent d00ea1d commit 74b770e

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/references/api/bindings/miniz.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -383,13 +383,16 @@ Creates a new ZIP file reader for the given `fileSystemPath`. The `flags` passed
383383
This function is suitable if loading the entire file into memory is acceptable. Use a [deflator](#deflator) for streaming.
384384
:::
385385

386+
Returns `nil` and an error message in case of failure. Otherwise the ZIP [reader](#ZipFileReader) should be ready to use.
387+
386388
<Function>
387389
<Parameters>
388390
<Parameter name="fileSystemPath" type="string"/>
389391
<Parameter name="flags" type="number" optional/>
390392
</Parameters>
391393
<Returns>
392-
<Return name="reader" type="ZipFileReader"/>
394+
<Return name="reader" type="ZipFileReader" optional/>
395+
<Return name="errorMessage" type="string" optional/>
393396
</Returns>
394397
</Function>
395398

@@ -401,13 +404,16 @@ Creates a new ZIP file reader for the given `fileContents`. The `flags` passed t
401404
This function is suitable if loading the entire file into memory is acceptable. Use a [deflator](#deflator) for streaming.
402405
:::
403406

407+
Returns `nil` and an error message in case of failure. Otherwise the ZIP [reader](#ZipFileReader) should be ready to use.
408+
404409
<Function>
405410
<Parameters>
406411
<Parameter name="fileContents" type="string"/>
407412
<Parameter name="flags" type="number" optional/>
408413
</Parameters>
409414
<Returns>
410-
<Return name="reader" type="ZipFileReader"/>
415+
<Return name="reader" type="ZipFileReader" optional/>
416+
<Return name="errorMessage" type="string" optional/>
411417
</Returns>
412418
</Function>
413419

0 commit comments

Comments
 (0)