Class PaxHeader

Adds support for extended headers. https://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html#tag_20_92_13_03

Hierarchy

PaxHeader

Implements

TarSerializable

Constructors

constructor

new PaxHeader(segments?: PaxHeaderSegment[]): PaxHeader
Parameters
- segments: PaxHeaderSegment[] = []
Returns PaxHeader
- Defined in header/pax/pax-header.ts:31

Accessors

accessTime

get accessTime(): undefined | number
See PaxHeaderKey.ACCESS_TIME for more info

Returns undefined | number
- Defined in header/pax/pax-header.ts:158

charset

get charset(): undefined | string
See PaxHeaderKey.CHARSET for more info

Returns undefined | string
- Defined in header/pax/pax-header.ts:165

comment

get comment(): undefined | string
See PaxHeaderKey.COMMENT for more info

Returns undefined | string
- Defined in header/pax/pax-header.ts:172

groupId

get groupId(): undefined | number
See PaxHeaderKey.GROUP_ID for more info

Returns undefined | number
- Defined in header/pax/pax-header.ts:179

groupName

get groupName(): undefined | string
See PaxHeaderKey.GROUP_NAME for more info

Returns undefined | string
- Defined in header/pax/pax-header.ts:186

hdrCharset

get hdrCharset(): undefined | string
See PaxHeaderKey.HDR_CHARSET for more info

Returns undefined | string
- Defined in header/pax/pax-header.ts:193

lastModified

get lastModified(): undefined | number
Converts modificationTime to standard javascript epoch time.

Returns undefined | number
- Defined in header/pax/pax-header.ts:242

linkPath

get linkPath(): undefined | string
See PaxHeaderKey.LINK_PATH for more info

Returns undefined | string
- Defined in header/pax/pax-header.ts:200

modificationTime

get modificationTime(): undefined | number
See PaxHeaderKey.MODIFICATION_TIME for more info

Returns undefined | number
- Defined in header/pax/pax-header.ts:207

path

get path(): undefined | string
See PaxHeaderKey.PATH for more info

Returns undefined | string
- Defined in header/pax/pax-header.ts:214

size

get size(): undefined | number
See PaxHeaderKey.SIZE for more info

Returns undefined | number
- Defined in header/pax/pax-header.ts:221

userId

get userId(): undefined | number
See PaxHeaderKey.USER_ID for more info

Returns undefined | number
- Defined in header/pax/pax-header.ts:228

userName

get userName(): undefined | string
See PaxHeaderKey.USER_NAME for more info

Returns undefined | string
- Defined in header/pax/pax-header.ts:235

Methods

clean

clean(): PaxHeader
Removes any unknown or un-standardized keys from this header.

Returns
this for operation chaining

Returns PaxHeader
- Defined in header/pax/pax-header.ts:265

get

get(key: string): undefined | string
Returns
the value parsed from the bytes of this header for the given key, or undefined if the key did not exist in the header.
Parameters
- key: string
Returns undefined | string
- Defined in header/pax/pax-header.ts:286

getFloat

getFloat(key: string): undefined | number
Parse the value for the given key as a float.

Returns
undefined if the key does not exist or the parse operation fails.
Parameters
- key: string
Returns undefined | number
- Defined in header/pax/pax-header.ts:302

getInt

getInt(key: string): undefined | number
Parse the value for the given key as an int.

Returns
undefined if the key does not exist or the parse operation fails.
Parameters
- key: string
Returns undefined | number
- Defined in header/pax/pax-header.ts:294

has

has(key: string): boolean
Returns
true if the value map of this parsed header contains the given key
Parameters
- key: string
Returns boolean
- Defined in header/pax/pax-header.ts:278

keys

keys(): string[]
Returns
an array of the keys in this header

Returns string[]
- Defined in header/pax/pax-header.ts:250

toJSON

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

toUint8Array

toUint8Array(): Uint8Array
Serializes the underlying value map of this instance into a set of PAX sectors.

Returns Uint8Array
Implementation of TarSerializable.toUint8Array
- Defined in header/pax/pax-header.ts:309

toUint8ArrayPadded

toUint8ArrayPadded(): Uint8Array
Adds any necessary padding to the serialized output to ensure the length of the output is a multiple of SECTOR_SIZE.

See toUint8Array() for more info.

Returns Uint8Array
- Defined in header/pax/pax-header.ts:319

values

values(): PaxHeaderSegment[]
Returns
an array of the segments in this header

Returns PaxHeaderSegment[]
- Defined in header/pax/pax-header.ts:257

`Static` deserialize

deserialize(buffer: Uint8Array, offset?: number): PaxHeader
Parameters
- buffer: Uint8Array
- offset: number = 0
Returns PaxHeader
- Defined in header/pax/pax-header.ts:38

`Static` fromAttributes

fromAttributes(attributes: Partial<PaxHeaderAttributes>): PaxHeader
Parameters
- attributes: Partial<PaxHeaderAttributes>
Returns PaxHeader
- Defined in header/pax/pax-header.ts:43

`Static` parseSegmentsFromAttributes

parseSegmentsFromAttributes(attributes: Partial<PaxHeaderAttributes>): PaxHeaderSegment[]
Parameters
- attributes: Partial<PaxHeaderAttributes>
Returns PaxHeaderSegment[]
- Defined in header/pax/pax-header.ts:53

`Static` serializeAttributes

serializeAttributes(attributes: Partial<PaxHeaderAttributes>): Uint8Array
Parameters
- attributes: Partial<PaxHeaderAttributes>
Returns Uint8Array
- Defined in header/pax/pax-header.ts:48

`Static` serializeSegments

serializeSegments(segments: PaxHeaderSegment[]): Uint8Array
Parameters
- segments: PaxHeaderSegment[]
Returns Uint8Array
- Defined in header/pax/pax-header.ts:68

`Static` wrapFileName

wrapFileName(fileName: string): string
Wraps the given file name (if necessary) with the 'PaxHeader' metadata indicator. If the indicator already exists in the given file name, this does nothing.
Parameters
- fileName: string
Returns string
- Defined in header/pax/pax-header.ts:97

Generated using TypeDoc