Skip to content

Commit a8951a2

Browse files
committed
update readme
1 parent 6eb8242 commit a8951a2

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ If you ever have a use case for calling this function directly please
153153
[open an issue against yauzl](https://github.com/thejoshwolfe/yauzl/issues/new)
154154
requesting that this function be properly supported again.
155155

156-
This function only remains exported in order to maintain compatibility with older version of yauzl.
156+
This function only remains exported in order to maintain compatibility with older versions of yauzl.
157157
It will be removed in yauzl 4.0.0 unless someone asks for it to remain supported.
158158

159159
### getFileNameLowLevel(generalPurposeBitFlag, fileNameBuffer, extraFields, strictFileNames)
@@ -344,7 +344,7 @@ and this function gives the corresponding redundant data in a Local File Header.
344344
}
345345
```
346346

347-
If `minimal` is `false` (or omitted or `null`), the callback receives a full `LocalFileHeader`.
347+
If `minimal` is `false` (or omitted or `null`), the callback receives a full [`LocalFileHeader`](#class-localfileheader).
348348
If `minimal` is `true`, the callback receives an object with a single property and no prototype `{fileDataStart: fileDataStart}`.
349349
For typical zipfile reading usecases, this field is the only one you need,
350350
and yauzl internally effectively uses the `{minimal: true}` option as part of `openReadStream()`.
@@ -481,8 +481,7 @@ the file name in this field is stored in the `fileName` property,
481481
and the file name in the central directory record for this entry is ignored.
482482
Note that when `decodeStrings` is false, all Info-ZIP Unicode Path Extra Fields are ignored.
483483

484-
None of the other fields are considered significant by this library.
485-
Fields that this library reads are left unaltered in the `extraFields` array.
484+
See also [`getLastModDate()`](#getlastmoddateoptions) for additional extra fields that are recognized by this library.
486485

487486
#### fileComment
488487

0 commit comments

Comments
 (0)