Optional entries: ArchiveEntry[]Convenience option for building tarball data
this for operation chaining
the file name, e.g. './relative/path/to/your/file.bin'
the content of the file (shocker!)
custom options for this entry
Convenience option for building tarball data
this for operation chaining
the directory name, e.g. './relative/path/to/your/dir'
custom options for this entry
Convenience for appending a new entry to the existing entries array
this for operation chaining
Convenience for appending a new entry to the existing entries array.
this for operation chaining
Optional content: Uint8ArrayConvenience option for building tarball data
this for operation chaining
the file name, e.g. './relative/path/to/your/file.txt'
the content of the file (shocker!)
Optional headerOptions: Partial<UstarHeaderLike>custom options for this entry
Removes any entries from this writer's cache that meet the given predicate condition.
this for operation chaining
delegate that will return true for any entry that should be removed.
Static extractParses an Archive instance from the given buffer, with all entries read into memory. The buffer should come from a complete, uncompressed tar file.
Static readIterate over entries in-place from a given source buffer. The buffer should come from a complete, uncompressed tar file.
Static serializeCombines the given array of entries into a single, complete tarball buffer
Generated using TypeDoc
Main entry point for extracting and creating tarballs. See TarIterator and ArchiveEntry for more granular options.