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(attributes?: Partial<UstarHeaderLike>): UstarHeader
Parameters
- attributes: Partial<UstarHeaderLike> = {}
Returns UstarHeader
- Defined in header/ustar/ustar-header.ts:18

Accessors

deviceMajorNumber

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

deviceMinorNumber

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

fileMode

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

fileName

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

fileNamePrefix

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

fileSize

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

groupUserId

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

headerChecksum

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

isDirectoryHeader

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

isFileHeader

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

isGlobalPaxHeader

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

isLocalPaxHeader

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

isPaxHeader

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

lastModified

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

linkedFileName

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

ownerGroupName

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

ownerUserId

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

ownerUserName

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

typeFlag

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

ustarIndicator

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

ustarVersion

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

Methods

toAttributes

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

toJSON

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

toUint8Array

toUint8Array(): Uint8Array
Returns Uint8Array
Implementation of TarSerializable.toUint8Array
- Defined in header/ustar/ustar-header.ts:236

update

update(attributes: Partial<UstarHeaderLike>): UstarHeader
Parameters
- attributes: Partial<UstarHeaderLike>
Returns UstarHeader
- Defined in header/ustar/ustar-header.ts:227

`Static` defaultValues

defaultValues(): UstarHeaderLike
Returns UstarHeaderLike
- Defined in header/ustar/ustar-header.ts:62

`Static` deserialize

deserialize(input: Uint8Array, offset?: number): null | UstarHeader
Parses out a UstarHeader instance from the given input buffer, at the given offset. The given offset must be a multiple of SECTOR_SIZE.

If the sector at the given offset is not marked with a ustar indicator, this will return null.
Parameters
- input: Uint8Array
- offset: number = 0
Returns null | UstarHeader
- Defined in header/ustar/ustar-header.ts:48

`Static` fromAttributes

fromAttributes(attributes: 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
- attributes: Partial<UstarHeaderLike>
Returns UstarHeader
- Defined in header/ustar/ustar-header.ts:30

`Static` isUstarHeader

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

`Static` serializeAttributes

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

Generated using TypeDoc