@obsidize/tar-browserify
    Preparing search index...

    Class PaxHeader

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

    Implements

    Index

    Constructors

    constructor

    Accessors

    accessTime charset comment groupId groupName hdrCharset lastModified linkPath modificationTime path size userId userName

    Methods

    clean get getFloat getInt has keys toJSON toUint8Array toUint8ArrayPadded values deserialize fromAttributes parseSegmentsFromAttributes serializeAttributes serializeSegments wrapFileName

    Constructors

    Accessors

    • get accessTime(): undefined | number

      See PaxHeaderKey.ACCESS_TIME for more info

      Returns undefined | number

    • get groupName(): undefined | string

      See PaxHeaderKey.GROUP_NAME for more info

      Returns undefined | string

    • get hdrCharset(): undefined | string

      See PaxHeaderKey.HDR_CHARSET for more info

      Returns undefined | string

    • get lastModified(): undefined | number

      Converts modificationTime to standard javascript epoch time.

      Returns undefined | number

    • get linkPath(): undefined | string

      See PaxHeaderKey.LINK_PATH for more info

      Returns undefined | string

    • get modificationTime(): undefined | number

      See PaxHeaderKey.MODIFICATION_TIME for more info

      Returns undefined | number

    • get userName(): undefined | string

      See PaxHeaderKey.USER_NAME for more info

      Returns undefined | string

    Methods

    • Removes any unknown or un-standardized keys from this header.

      Returns this

      this for operation chaining

    • Parameters

      • key: string

      Returns undefined | string

      the value parsed from the bytes of this header for the given key, or undefined if the key did not exist in the header.

    • Parse the value for the given key as a float.

      Parameters

      • key: string

      Returns undefined | number

      undefined if the key does not exist or the parse operation fails.

    • Parse the value for the given key as an int.

      Parameters

      • key: string

      Returns undefined | number

      undefined if the key does not exist or the parse operation fails.

    • Parameters

      • key: string

      Returns boolean

      true if the value map of this parsed header contains the given key

    • 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

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods