Class TarHeader

Facade over a backing Uint8Array buffer to consume/edit header data at a specific location in the buffer.

Does not perform any mutations or reads on creation, and lazy loads/sets data via getters and setters.

Implements

Constructors

constructor

new TarHeader(options: TarHeaderOptions): TarHeader
Parameters
- options: TarHeaderOptions
Returns TarHeader
- Defined in header/tar-header.ts:32

Properties

`Readonly`gnu

gnu: undefined | GnuHeader

`Readonly`pax

pax: undefined | PaxHeader

`Readonly`ustar

ustar: UstarHeader

Accessors

deviceMajorNumber

get deviceMajorNumber(): string
Returns string
Implementation of UstarHeaderLike.deviceMajorNumber
- Defined in header/tar-header.ts:172

deviceMinorNumber

get deviceMinorNumber(): string
Returns string
Implementation of UstarHeaderLike.deviceMinorNumber
- Defined in header/tar-header.ts:176

fileMode

get fileMode(): number
Returns number
Implementation of UstarHeaderLike.fileMode
- Defined in header/tar-header.ts:124

fileName

get fileName(): string
Returns string
Implementation of UstarHeaderLike.fileName
- Defined in header/tar-header.ts:120

fileNamePrefix

get fileNamePrefix(): string
Returns string
Implementation of UstarHeaderLike.fileNamePrefix
- Defined in header/tar-header.ts:180

fileSize

get fileSize(): number
Returns number
Implementation of UstarHeaderLike.fileSize
- Defined in header/tar-header.ts:136

groupUserId

get groupUserId(): number
Returns number
Implementation of UstarHeaderLike.groupUserId
- Defined in header/tar-header.ts:132

headerChecksum

get headerChecksum(): number
Returns number
Implementation of UstarHeaderLike.headerChecksum
- Defined in header/tar-header.ts:144

isDirectoryHeader

get isDirectoryHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:188

isFileHeader

get isFileHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:184

isGlobalPaxHeader

get isGlobalPaxHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:196

isGlobalPaxPostHeader

get isGlobalPaxPostHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:212

isGlobalPaxPreHeader

get isGlobalPaxPreHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:204

isGnuLongLinkPathHeader

get isGnuLongLinkPathHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:224

isGnuLongLinkPathPostHeader

get isGnuLongLinkPathPostHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:240

isGnuLongLinkPathPreHeader

get isGnuLongLinkPathPreHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:232

isGnuLongPathHeader

get isGnuLongPathHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:220

isGnuLongPathPostHeader

get isGnuLongPathPostHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:236

isGnuLongPathPreHeader

get isGnuLongPathPreHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:228

isLocalPaxHeader

get isLocalPaxHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:200

isLocalPaxPostHeader

get isLocalPaxPostHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:216

isLocalPaxPreHeader

get isLocalPaxPreHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:208

isPaxHeader

get isPaxHeader(): boolean
Returns boolean
- Defined in header/tar-header.ts:192

lastModified

get lastModified(): number
Returns number
Implementation of UstarHeaderLike.lastModified
- Defined in header/tar-header.ts:140

linkedFileName

get linkedFileName(): string
Returns string
Implementation of UstarHeaderLike.linkedFileName
- Defined in header/tar-header.ts:148

ownerGroupName

get ownerGroupName(): string
Returns string
Implementation of UstarHeaderLike.ownerGroupName
- Defined in header/tar-header.ts:168

ownerUserId

get ownerUserId(): number
Returns number
Implementation of UstarHeaderLike.ownerUserId
- Defined in header/tar-header.ts:128

ownerUserName

get ownerUserName(): string
Returns string
Implementation of UstarHeaderLike.ownerUserName
- Defined in header/tar-header.ts:164

preamble

get preamble(): undefined | UstarHeader
Returns undefined | UstarHeader
- Defined in header/tar-header.ts:116

typeFlag

get typeFlag(): UstarHeaderLinkIndicatorType
Returns UstarHeaderLinkIndicatorType
Implementation of UstarHeaderLike.typeFlag
- Defined in header/tar-header.ts:152

ustarIndicator

get ustarIndicator(): string
Returns string
Implementation of UstarHeaderLike.ustarIndicator
- Defined in header/tar-header.ts:156

ustarVersion

get ustarVersion(): string
Returns string
Implementation of UstarHeaderLike.ustarVersion
- Defined in header/tar-header.ts:160

Methods

clean

clean(): this
Removes any unknown or un-standardized keys from the PAX portion of this header (if one exists).

See also PaxHeader.clean().

Returns this
this for operation chaining
- Defined in header/tar-header.ts:252

toJSON

toJSON(): Record<string, unknown>
Returns Record<string, unknown>
- Defined in header/tar-header.ts:298

toUint8Array

toUint8Array(): Uint8Array
Returns Uint8Array
A snapshot of the underlying buffer for this header
Implementation of TarSerializable.toUint8Array
- Defined in header/tar-header.ts:271

`Static`fromAttributes

fromAttributes(attributes: Partial<UstarHeaderLike>): TarHeader
Parameters
- attributes: Partial<UstarHeaderLike>
Returns TarHeader
A new TarHeader instance based on the given attributes (if they are a POJO). Note that if the given value is already a TarHeader instance, this will return it as-is.
- Defined in header/tar-header.ts:50

`Static`isTarHeader

isTarHeader(value: any): boolean
Parameters
- value: any
Returns boolean
- Defined in header/tar-header.ts:42

`Static`serializeAttributes

serializeAttributes(attributes: Partial<UstarHeaderLike>): Uint8Array
Short-hand for constructing a new TarHeader and immediately calling toUint8Array() on it
Parameters
- attributes: Partial<UstarHeaderLike>
Returns Uint8Array
- Defined in header/tar-header.ts:74