Add a contentsByteOffset to the header emitted on entry events. #170
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When emitting the header for an entry event, the contentsByteOffset property is added to the header object. This property is the byte offset of the start of the entry's file contents in the tar stream, after the header. This is useful when building an index of a tar's contents, for later seeking to a specific entry's contents in the tar stream. Headers can be variable length based on the tar implementation.
mafintosh
reviewed
Jan 15, 2025
extract.js
Outdated
| @@ -169,8 +169,9 @@ class Extract extends Writable { | |||
|
|
|||
| this._stream = this._createStream() | |||
| this._missing = this._header.size | |||
| const header = { ...this._header, contentsByteOffset: this._buffer.shifted } | |||
There was a problem hiding this comment.
i think we can name it byteOffset just, similar to how that property is normally used.
in headers.decode, just declare it there and init it to 0, then simply mutate it in here instead of the spread
There was a problem hiding this comment.
I've applied these changes. Thank you! 🙏
|
nice, commented |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When emitting the header for an entry event, the contentsByteOffset property is added to the header object. This property is the byte offset of the start of the entry's file contents in the tar stream, after the header.
This is useful when building an index of a tar's contents, for later seeking to a specific entry's contents in the tar stream.
Headers can be variable length based on the tar implementation.
Fixes #162. I'm happy to change this if we prefer a different approach.