Generic utility for building a tar octet stream by adding JSON-style entries. See the add***() options in this class definition for details.

Hierarchy

Implements

Constructors

Properties

entries: ArchiveEntry[] = []

Methods

  • Convenience option for building tarball data

    Returns

    this for operation chaining

    Parameters

    • path: string

      the file name, e.g. './relative/path/to/your/file.bin'

    • content: Uint8Array

      the content of the file (shocker!)

    • headerOptions: Partial<UstarHeaderLike> = {}

      custom options for this entry

    Returns ArchiveWriter

  • Convenience option for building tarball data

    Returns

    this for operation chaining

    Parameters

    • path: string

      the file name, e.g. './relative/path/to/your/file.txt'

    • content: string

      the content of the file (shocker!)

    • Optional headerOptions: Partial<UstarHeaderLike>

      custom options for this entry

    Returns ArchiveWriter

  • Convenience option for cleaning the header of each listed entry. When headers are "cleaned", unknown PAX properties will be removed (e.g. unwanted MacOS "quarantine" headers), and USTAR fields will be normalized (if necessary).

    Returns ArchiveWriter

Generated using TypeDoc