Class ArchiveEntry

Container for metadata and content of a tarball entry.

Here, we consider an "entry" to be a tuple of:

  1. The parsed USTAR header sector content (AKA TarHeader)
  2. The aggregate of the proceeding file content sectors, based on the header's file size attribute

Hierarchy

  • ArchiveEntry

Implements

Constructors

constructor

Accessors

content deviceMajorNumber deviceMinorNumber fileMode fileName fileNamePrefix fileSize groupUserId header headerChecksum lastModified linkedFileName ownerGroupName ownerUserId ownerUserName sourceContext sourceHeaderByteLength sourceOffset typeFlag ustarIndicator ustarVersion

Methods

isDirectory isFile readContentFrom text toJSON toUint8Array isArchiveEntry

Constructors

constructor

Accessors

content

  • get content(): undefined | null | Uint8Array

  • The file content for this entry. This may be null for entries loaded asynchronously, or for non-file entries like directories.

    Returns undefined | null | Uint8Array

deviceMajorNumber

deviceMinorNumber

fileMode

fileName

fileNamePrefix

fileSize

groupUserId

header

headerChecksum

lastModified

linkedFileName

ownerGroupName

ownerUserId

ownerUserName

sourceContext

  • get sourceContext(): undefined | null | ArchiveContext

  • The context (if any) from which this entry was parsed. The context will include global data about things such as the origin of the archive and global pax headers.

    Returns undefined | null | ArchiveContext

sourceHeaderByteLength

  • get sourceHeaderByteLength(): number

  • The size in bytes of the header in the source buffer that this entry was parsed from. Returns zero by default if this was not parsed by a source buffer.

    Returns number

sourceOffset

  • get sourceOffset(): number

  • The starting absolute index (inclusive) in the source buffer that this entry was parsed from. Returns zero by default if this was not parsed by a source buffer.

    Returns number

typeFlag

ustarIndicator

ustarVersion

Methods

isDirectory

isFile

readContentFrom

  • Only necessary if this entry was extracted from an async buffer, since the entry does not hold the content of async buffers by default.

    If the entry was extracted synchronously, its content will be available via the "content" property.

    Do not use this on entries that have not been parsed from a source buffer, otherwise it will very likely return garbage data.

    Parameters

    • buffer: AsyncUint8ArrayLike

      the source to read content from

    • offset: number = 0

      the relative offset of the content to read; setting this to 42 will start reading at the 42nd byte index within the content block

    • length: number = 0

      the number of bytes to read after the offset

    Returns Promise<Uint8Array>

text

  • Convenience for decoding the current content buffer as a string. Note that if the content was not loaded for whatever reason, this will return an empty string.

    Returns

    The decoded string data from the currently assigned content, or an empty string if there is no content assigned.

    Returns string

toJSON

  • Overridden to prevent circular reference errors / huge memory spikes that would include the underlying content by default.

    Returns Record<string, unknown>

toUint8Array

Static isArchiveEntry

Settings

Member Visibility

Theme

Generated using TypeDoc