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.

Hierarchy

TarHeader

Implements

Constructors

constructor

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

Properties

`Readonly` pax

pax: undefined | PaxTarHeader

`Readonly` ustar

ustar: UstarHeader

Accessors

byteLength

get byteLength(): number
Returns number
- Defined in header/tar-header.ts:122

deviceMajorNumber

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

deviceMinorNumber

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

fileMode

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

fileName

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

fileNamePrefix

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

fileSize

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

groupUserId

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

headerChecksum

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

isDirectoryHeader

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

isFileHeader

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

isGlobalPaxHeader

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

isGlobalPaxPostHeader

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

isGlobalPaxPreHeader

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

isLocalPaxHeader

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

isLocalPaxPostHeader

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

isLocalPaxPreHeader

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

isPaxHeader

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

lastModified

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

linkedFileName

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

ownerGroupName

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

ownerUserId

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

ownerUserName

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

preamble

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

typeFlag

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

ustarIndicator

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

ustarVersion

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

Methods

clean

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

See also PaxTarHeader.clean().

Returns
this for operation chaining

Returns TarHeader
- Defined in header/tar-header.ts:237

toJSON

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

toUint8Array

toUint8Array(): Uint8Array
Returns
A snapshot of the underlying buffer for this header

Returns Uint8Array
Implementation of TarSerializable.toUint8Array
- Defined in header/tar-header.ts:257

`Static` from

from(attrs: Partial<UstarHeaderLike>): TarHeader
Returns
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.
Parameters
- attrs: Partial<UstarHeaderLike>
Returns TarHeader
- Defined in header/tar-header.ts:52

`Static` isTarHeader

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

`Static` seeded

seeded(): TarHeader
Returns
A new TarHeader instance populated with the content returned by defaultValues()

Returns TarHeader
- Defined in header/tar-header.ts:44

`Static` serialize

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

Generated using TypeDoc