Class PaxTarHeaderSegment

Single segment in a PAX header block, represented by a text line with the format: LENGTH KEY=VALUE\n

Hierarchy

PaxTarHeaderSegment

Implements

TarSerializable

Index

Constructors

Accessors

bytes floatValue intValue key value

Methods

toJSON toUint8Array serialize tryParse

Constructors

constructor

new PaxTarHeaderSegment(mKey?: string, mValue?: string, mBytes?: null | Uint8Array): PaxTarHeaderSegment
Parameters
- mKey: string = ''
- mValue: string = ''
- mBytes: null | Uint8Array = null
Returns PaxTarHeaderSegment
- Defined in header/pax/pax-tar-header-segment.ts:11

Accessors

bytes

get bytes(): Uint8Array
Returns Uint8Array
- Defined in header/pax/pax-tar-header-segment.ts:95

floatValue

get floatValue(): undefined | number
the value parsed as a float, or undefined if the parse operation fails

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

intValue

get intValue(): undefined | number
the value parsed as an integer, or undefined if the parse operation fails

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

key

get key(): string
Returns string
- Defined in header/pax/pax-tar-header-segment.ts:87

value

get value(): string
Returns string
- Defined in header/pax/pax-tar-header-segment.ts:91

Methods

toJSON

toJSON(): any
Returns any
- Defined in header/pax/pax-tar-header-segment.ts:123

toUint8Array

toUint8Array(): Uint8Array
Returns Uint8Array
Implementation of TarSerializable.toUint8Array
- Defined in header/pax/pax-tar-header-segment.ts:115

`Static` serialize

serialize(key: string, value: string): Uint8Array
Parameters
- key: string
- value: string
Returns Uint8Array
- Defined in header/pax/pax-tar-header-segment.ts:18

`Static` tryParse

tryParse(bytes: Uint8Array, offset?: number): null | PaxTarHeaderSegment
Parameters
- bytes: Uint8Array
- offset: number = 0
Returns null | PaxTarHeaderSegment
- Defined in header/pax/pax-tar-header-segment.ts:37

Generated using TypeDoc