Class UstarHeader

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

UstarHeader

Implements

Constructors

constructor

new UstarHeader(bytes?: Uint8Array, offset?: number): UstarHeader
Parameters
- bytes: Uint8Array = ...
- offset: number = 0
Returns UstarHeader
- Defined in header/ustar/ustar-header.ts:16

Properties

`Readonly` bytes

bytes: Uint8Array = ...

`Readonly` offset

offset: number = 0

Accessors

byteLength

get byteLength(): number
Returns number
- Defined in header/ustar/ustar-header.ts:80

deviceMajorNumber

get deviceMajorNumber(): string
Returns string
Implementation of UstarHeaderLike.deviceMajorNumber
- Defined in header/ustar/ustar-header.ts:185
set deviceMajorNumber(value: string): void
Parameters
- value: string
Returns void
Implementation of UstarHeaderLike.deviceMajorNumber
- Defined in header/ustar/ustar-header.ts:189

deviceMinorNumber

get deviceMinorNumber(): string
Returns string
Implementation of UstarHeaderLike.deviceMinorNumber
- Defined in header/ustar/ustar-header.ts:193
set deviceMinorNumber(value: string): void
Parameters
- value: string
Returns void
Implementation of UstarHeaderLike.deviceMinorNumber
- Defined in header/ustar/ustar-header.ts:197

fileMode

get fileMode(): number
Returns number
Implementation of UstarHeaderLike.fileMode
- Defined in header/ustar/ustar-header.ts:92
set fileMode(value: number): void
Parameters
- value: number
Returns void
Implementation of UstarHeaderLike.fileMode
- Defined in header/ustar/ustar-header.ts:96

fileName

get fileName(): string
Returns string
Implementation of UstarHeaderLike.fileName
- Defined in header/ustar/ustar-header.ts:84
set fileName(value: string): void
Parameters
- value: string
Returns void
Implementation of UstarHeaderLike.fileName
- Defined in header/ustar/ustar-header.ts:88

fileNamePrefix

get fileNamePrefix(): string
Returns string
Implementation of UstarHeaderLike.fileNamePrefix
- Defined in header/ustar/ustar-header.ts:201
set fileNamePrefix(value: string): void
Parameters
- value: string
Returns void
Implementation of UstarHeaderLike.fileNamePrefix
- Defined in header/ustar/ustar-header.ts:205

fileSize

get fileSize(): number
Returns number
Implementation of UstarHeaderLike.fileSize
- Defined in header/ustar/ustar-header.ts:116
set fileSize(value: number): void
Parameters
- value: number
Returns void
Implementation of UstarHeaderLike.fileSize
- Defined in header/ustar/ustar-header.ts:120

groupUserId

get groupUserId(): number
Returns number
Implementation of UstarHeaderLike.groupUserId
- Defined in header/ustar/ustar-header.ts:108
set groupUserId(value: number): void
Parameters
- value: number
Returns void
Implementation of UstarHeaderLike.groupUserId
- Defined in header/ustar/ustar-header.ts:112

headerChecksum

get headerChecksum(): number
Returns number
Implementation of UstarHeaderLike.headerChecksum
- Defined in header/ustar/ustar-header.ts:132
set headerChecksum(value: number): void
Parameters
- value: number
Returns void
Implementation of UstarHeaderLike.headerChecksum
- Defined in header/ustar/ustar-header.ts:136

isDirectoryHeader

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

isFileHeader

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

isGlobalPaxHeader

get isGlobalPaxHeader(): boolean
Returns boolean
- Defined in header/ustar/ustar-header.ts:213

isLocalPaxHeader

get isLocalPaxHeader(): boolean
Returns boolean
- Defined in header/ustar/ustar-header.ts:217

isPaxHeader

get isPaxHeader(): boolean
Returns boolean
- Defined in header/ustar/ustar-header.ts:209

lastModified

get lastModified(): number
Returns number
Implementation of UstarHeaderLike.lastModified
- Defined in header/ustar/ustar-header.ts:124
set lastModified(value: number): void
Parameters
- value: number
Returns void
Implementation of UstarHeaderLike.lastModified
- Defined in header/ustar/ustar-header.ts:128

linkedFileName

get linkedFileName(): string
Returns string
Implementation of UstarHeaderLike.linkedFileName
- Defined in header/ustar/ustar-header.ts:140
set linkedFileName(value: string): void
Parameters
- value: string
Returns void
Implementation of UstarHeaderLike.linkedFileName
- Defined in header/ustar/ustar-header.ts:144

ownerGroupName

get ownerGroupName(): string
Returns string
Implementation of UstarHeaderLike.ownerGroupName
- Defined in header/ustar/ustar-header.ts:177
set ownerGroupName(value: string): void
Parameters
- value: string
Returns void
Implementation of UstarHeaderLike.ownerGroupName
- Defined in header/ustar/ustar-header.ts:181

ownerUserId

get ownerUserId(): number
Returns number
Implementation of UstarHeaderLike.ownerUserId
- Defined in header/ustar/ustar-header.ts:100
set ownerUserId(value: number): void
Parameters
- value: number
Returns void
Implementation of UstarHeaderLike.ownerUserId
- Defined in header/ustar/ustar-header.ts:104

ownerUserName

get ownerUserName(): string
Returns string
Implementation of UstarHeaderLike.ownerUserName
- Defined in header/ustar/ustar-header.ts:169
set ownerUserName(value: string): void
Parameters
- value: string
Returns void
Implementation of UstarHeaderLike.ownerUserName
- Defined in header/ustar/ustar-header.ts:173

typeFlag

get typeFlag(): UstarHeaderLinkIndicatorType
Returns UstarHeaderLinkIndicatorType
Implementation of UstarHeaderLike.typeFlag
- Defined in header/ustar/ustar-header.ts:148
set typeFlag(value: UstarHeaderLinkIndicatorType): void
Parameters
- value: UstarHeaderLinkIndicatorType
Returns void
Implementation of UstarHeaderLike.typeFlag
- Defined in header/ustar/ustar-header.ts:153

ustarIndicator

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

ustarVersion

get ustarVersion(): string
Returns string
Implementation of UstarHeaderLike.ustarVersion
- Defined in header/ustar/ustar-header.ts:161
set ustarVersion(value: string): void
Parameters
- value: string
Returns void
Implementation of UstarHeaderLike.ustarVersion
- Defined in header/ustar/ustar-header.ts:165

Methods

initialize

initialize(attrs?: UstarHeaderLike | Partial<UstarHeaderLike>): UstarHeader
Override all values in the header. Any values not provided in attrs will be filled in with default values.

Returns
this for operation chaining
Parameters
- attrs: UstarHeaderLike | Partial<UstarHeaderLike> = {}
Returns UstarHeader
- Defined in header/ustar/ustar-header.ts:297

toAttributes

toAttributes(): UstarHeaderLike
Returns UstarHeaderLike
- Defined in header/ustar/ustar-header.ts:253

toJSON

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

toUint8Array

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

Returns Uint8Array
Implementation of TarSerializable.toUint8Array
- Defined in header/ustar/ustar-header.ts:232

update

update(attrs: UstarHeaderLike | Partial<UstarHeaderLike>): UstarHeader
Mechanism to batch-update properties. Automatically normalizes the header if any changes were made.

Returns
this for operation chaining
Parameters
- attrs: UstarHeaderLike | Partial<UstarHeaderLike>
Returns UstarHeader
- Defined in header/ustar/ustar-header.ts:323

updateChecksum

updateChecksum(): UstarHeader
Ensures the state of the header is synced after changes have been made.

Returns
this for operation chaining

Returns UstarHeader
- Defined in header/ustar/ustar-header.ts:307

`Static` defaultValues

defaultValues(): UstarHeaderLike
Returns
A copy of the defaults used by all headers

Returns UstarHeaderLike
- Defined in header/ustar/ustar-header.ts:25

`Static` from

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

`Static` isUstarHeader

isUstarHeader(value: any): boolean
Parameters
- value: any
Returns boolean
- Defined in header/ustar/ustar-header.ts:46

`Static` seeded

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

Returns UstarHeader
- Defined in header/ustar/ustar-header.ts:76

`Static` serialize

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

Generated using TypeDoc