Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thejoshwolfe committed Nov 4, 2024
1 parent 6eb8242 commit a8951a2
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ If you ever have a use case for calling this function directly please
[open an issue against yauzl](https://github.com/thejoshwolfe/yauzl/issues/new)
requesting that this function be properly supported again.

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

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

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

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

#### fileComment

Expand Down

0 comments on commit a8951a2

Please sign in to comment.