Class PaxTarHeader

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

Hierarchy

PaxTarHeader

Implements

TarSerializable

Index

Constructors

constructor

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

Accessors

accessTime

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

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

charset

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

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

comment

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

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

groupId

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

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

groupName

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

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

hdrCharset

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

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

lastModified

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

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

linkPath

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

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

modificationTime

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

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

path

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

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

size

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

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

userId

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

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

userName

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

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

Methods

clean

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

Returns
this for operation chaining

Returns PaxTarHeader
- Defined in header/pax/pax-tar-header.ts:269

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-tar-header.ts:313

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-tar-header.ts:329

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-tar-header.ts:321

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-tar-header.ts:305

keys

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

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

toJSON

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

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-tar-header.ts:336

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-tar-header.ts:346

values

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

Returns PaxTarHeaderSegment[]
- Defined in header/pax/pax-tar-header.ts:261

`Static` from

from(buffer: Uint8Array, offset?: number): PaxTarHeader
Parameters
- buffer: Uint8Array
- offset: number = 0
Returns PaxTarHeader
- Defined in header/pax/pax-tar-header.ts:40

`Static` fromAttributes

fromAttributes(attributes: Partial<PaxTarHeaderAttributes>): PaxTarHeader
Parameters
- attributes: Partial<PaxTarHeaderAttributes>
Returns PaxTarHeader
- Defined in header/pax/pax-tar-header.ts:45

`Static` parseSegmentsFromAttributes

parseSegmentsFromAttributes(attributes: Partial<PaxTarHeaderAttributes>): PaxTarHeaderSegment[]
Parameters
- attributes: Partial<PaxTarHeaderAttributes>
Returns PaxTarHeaderSegment[]
- Defined in header/pax/pax-tar-header.ts:55

`Static` serialize

serialize(segments: PaxTarHeaderSegment[]): Uint8Array
Parameters
- segments: PaxTarHeaderSegment[]
Returns Uint8Array
- Defined in header/pax/pax-tar-header.ts:70

`Static` serializeAttributes

serializeAttributes(attributes: Partial<PaxTarHeaderAttributes>): Uint8Array
Parameters
- attributes: Partial<PaxTarHeaderAttributes>
Returns Uint8Array
- Defined in header/pax/pax-tar-header.ts:50

`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-tar-header.ts:99

Generated using TypeDoc