@zip.js/zip.js
    Preparing search index...

    Interface LocalDirectory

    Represents the local file header fields of an entry, read when getting the entry data.

    interface LocalDirectory {
        bitFlag: EntryBitFlag;
        compressedSize?: number;
        compressionMethod?: number;
        crc32?: number;
        dataDescriptor?: LocalDataDescriptor;
        dataOffset: number;
        encrypted: boolean;
        extraField?: Map<number, EntryExtraField>;
        extraFieldAES?: EntryExtraFieldAES;
        extraFieldExtendedTimestamp?: EntryExtraFieldExtendedTimestamp;
        extraFieldInfoZip?: EntryExtraFieldUnix;
        extraFieldLength: number;
        extraFieldNTFS?: EntryExtraFieldNTFS;
        extraFieldPkwareUnix?: EntryExtraFieldUnixDates;
        extraFieldUnicodeComment?: EntryExtraFieldUnicode;
        extraFieldUnicodePath?: EntryExtraFieldUnicode;
        extraFieldUnix?: EntryExtraFieldUnix;
        extraFieldUnixType1?: EntryExtraFieldUnixDates;
        extraFieldUSDZ?: EntryExtraField;
        extraFieldZip64?: EntryExtraFieldZip64;
        filenameLength: number;
        lastModDate: Date;
        rawBitFlag: number;
        rawExtraField: Uint8Array;
        rawFilename?: Uint8Array<ArrayBufferLike>;
        rawLastModDate: number;
        signature?: number;
        uncompressedSize?: number;
        version: number;
    }
    Index
    bitFlag compressedSize? compressionMethod? crc32? dataDescriptor? dataOffset encrypted extraField? extraFieldAES? extraFieldExtendedTimestamp? extraFieldInfoZip? extraFieldLength extraFieldNTFS? extraFieldPkwareUnix? extraFieldUnicodeComment? extraFieldUnicodePath? extraFieldUnix? extraFieldUnixType1? extraFieldUSDZ? extraFieldZip64? filenameLength lastModDate rawBitFlag rawExtraField rawFilename? rawLastModDate signature? uncompressedSize? version
    bitFlag: EntryBitFlag

    The general purpose bit flag.

    compressedSize?: number

    The compressed size of the content.

    compressionMethod?: number

    The compression method.

    crc32?: number

    The CRC-32 checksum of the content.

    dataDescriptor?: LocalDataDescriptor

    The data descriptor record written after the content, when the entry has one.

    Only defined when the record has been read, i.e. when the ZipReaderOptions#checkOverlappingEntry or the ZipReaderOptions#checkOverlappingEntryOnly option is set to true, since the sizes stored in the central directory make it unnecessary to read it otherwise.

    dataOffset: number

    The byte offset of the entry data, i.e. EntryMetaData#offset plus the size of the local file header, of the filename and of the extra field. It can be used with Reader#createReadable to read the stored data directly, e.g. to serve ranged requests into an entry compressed with the "store" method.

    encrypted: boolean

    true if the entry is encrypted.

    extraField?: Map<number, EntryExtraField>

    The extra field.

    extraFieldAES?: EntryExtraFieldAES

    The AES extra field.

    extraFieldExtendedTimestamp?: EntryExtraFieldExtendedTimestamp

    The extended timestamp extra field.

    extraFieldInfoZip?: EntryExtraFieldUnix

    The Info-ZIP New Unix extra field (0x7875), storing variable-length uid/gid in both headers. It is read whenever the type 2 extra field (0x7855) is absent or carries no ids, which is its usual state in the central directory.

    extraFieldLength: number

    The length of the extra field in bytes.

    extraFieldNTFS?: EntryExtraFieldNTFS

    The NTFS extra field.

    extraFieldPkwareUnix?: EntryExtraFieldUnixDates

    The PKWARE Unix extra field (0x000d).

    extraFieldUnicodeComment?: EntryExtraFieldUnicode

    The Unicode comment extra field.

    extraFieldUnicodePath?: EntryExtraFieldUnicode

    The Unicode path extra field.

    extraFieldUnix?: EntryExtraFieldUnix

    The Info-ZIP Unix type 2 extra field (0x7855). Its uid/gid are stored in the local file header only, the central directory version carries no data and merely flags their presence.

    extraFieldUnixType1?: EntryExtraFieldUnixDates

    The Info-ZIP Unix type 1 extra field (0x5855).

    extraFieldUSDZ?: EntryExtraField

    The USDZ extra field.

    extraFieldZip64?: EntryExtraFieldZip64

    The Zip64 extra field.

    filenameLength: number

    The length of the filename in bytes.

    lastModDate: Date

    The last modification date.

    rawBitFlag: number

    The general purpose bit flag (raw).

    rawExtraField: Uint8Array

    The extra field (raw).

    rawFilename?: Uint8Array<ArrayBufferLike>

    The filename of the entry stored in the local file header (raw), which is allowed to differ from EntryMetaData#rawFilename.

    Only defined when the local filename has been read, i.e. when the ZipReaderOptions#strictness option is set to "strict" or when the ZipReaderOptions#checkLocalDirectory option is set to true, since reading it costs one read the central directory does not need.

    rawLastModDate: number

    The last modification date (raw).

    signature?: number

    The signature (CRC32 checksum) of the content.

    Use LocalDirectory#crc32 instead.

    uncompressedSize?: number

    The uncompressed size of the content.

    version: number

    The "Version" field.

    Settings
    Member Visibility

    On This Page
    Properties