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

    Interface DirectoryEntry

    Represents the metadata of an entry in a zip file (Core API).

    interface DirectoryEntry {
        bitFlag?: EntryBitFlag;
        comment: string;
        commentUTF8: boolean;
        compressedSize: number;
        compressionMethod: number;
        creationDate?: Date;
        directory: true;
        diskNumberStart: number;
        encrypted: boolean;
        executable: boolean;
        externalFileAttribute: number;
        externalFileAttributes: number;
        extraField?: Map<number, { data: Uint8Array; type: number }>;
        extraFieldAES?: EntryExtraFieldAES;
        extraFieldExtendedTimestamp?: EntryExtraField;
        extraFieldInfoZip?: EntryExtraField;
        extraFieldLength?: number;
        extraFieldNTFS?: EntryExtraField;
        extraFieldUnicodeComment?: EntryExtraFieldUnicode;
        extraFieldUnicodePath?: EntryExtraFieldUnicode;
        extraFieldUnix?: EntryExtraField;
        extraFieldUSDZ?: EntryExtraField;
        extraFieldZip64?: EntryExtraField;
        filename: string;
        filenameLength?: number;
        filenameUTF8: boolean;
        gid?: number;
        internalFileAttribute: number;
        internalFileAttributes: number;
        lastAccessDate?: Date;
        lastModDate: Date;
        localDirectory?: LocalDirectory;
        msdosAttributes?: {
            archive: boolean;
            directory: boolean;
            hidden: boolean;
            readOnly: boolean;
            system: boolean;
        };
        msdosAttributesRaw?: number;
        msDosCompatible: boolean;
        offset: number;
        rawBitFlag?: number;
        rawComment: Uint8Array;
        rawCreationDate?: number
        | bigint;
        rawExtraField: Uint8Array;
        rawFilename: Uint8Array;
        rawLastAccessDate?: number | bigint;
        rawLastModDate: number | bigint;
        setgid?: boolean;
        setuid?: boolean;
        signature: number;
        sticky?: boolean;
        uid?: number;
        uncompressedSize: number;
        unixExternalUpper?: number;
        unixMode?: number;
        version: number;
        versionMadeBy: number;
        zip64: boolean;
        zipCrypto: boolean;
    }

    Hierarchy (View Summary)

    Index
    bitFlag? comment commentUTF8 compressedSize compressionMethod creationDate? directory diskNumberStart encrypted executable externalFileAttribute externalFileAttributes extraField? extraFieldAES? extraFieldExtendedTimestamp? extraFieldInfoZip? extraFieldLength? extraFieldNTFS? extraFieldUnicodeComment? extraFieldUnicodePath? extraFieldUnix? extraFieldUSDZ? extraFieldZip64? filename filenameLength? filenameUTF8 gid? internalFileAttribute internalFileAttributes lastAccessDate? lastModDate localDirectory? msdosAttributes? msdosAttributesRaw? msDosCompatible offset rawBitFlag? rawComment rawCreationDate? rawExtraField rawFilename rawLastAccessDate? rawLastModDate setgid? setuid? signature sticky? uid? uncompressedSize unixExternalUpper? unixMode? version versionMadeBy zip64 zipCrypto
    bitFlag?: EntryBitFlag

    The general purpose bit flag.

    comment: string

    The comment of the entry.

    commentUTF8: boolean

    true if the comment is encoded in UTF-8.

    compressedSize: number

    The size of the compressed data in bytes.

    compressionMethod: number

    The compression method.

    creationDate?: Date

    The creation date.

    directory: true

    true if the entry is a directory.

    diskNumberStart: number

    The number of the disk where the entry data starts.

    encrypted: boolean

    true if the content of the entry is encrypted.

    executable: boolean

    true if the entry is an executable file

    externalFileAttribute: number

    The external file attribute (raw).

    Use EntryMetaData#externalFileAttributes instead.

    externalFileAttributes: number

    The 32-bit externalFileAttributes field is the authoritative on-disk metadata for each entry.

    • Upper 16 bits: Unix mode/type (e.g., permissions, file type)
    • Low 8 bits: MS-DOS file attributes (e.g., directory, read-only)

    When writing, all provided options are merged into this field. When reading, convenience fields are decoded from it. For most use cases, prefer the high-level options and fields; only advanced users need to manipulate the raw value directly.

    extraField?: Map<number, { data: Uint8Array; type: number }>

    The extra field.

    extraFieldAES?: EntryExtraFieldAES

    The AES extra field.

    extraFieldExtendedTimestamp?: EntryExtraField

    The extended timestamp extra field.

    extraFieldInfoZip?: EntryExtraField

    The Info-ZIP Unix extra field.

    extraFieldLength?: number

    The length of the extra field in bytes.

    extraFieldNTFS?: EntryExtraField

    The NTFS extra field.

    extraFieldUnicodeComment?: EntryExtraFieldUnicode

    The Unicode comment extra field.

    extraFieldUnicodePath?: EntryExtraFieldUnicode

    The Unicode path extra field.

    extraFieldUnix?: EntryExtraField

    The Unix extra field.

    extraFieldUSDZ?: EntryExtraField

    The USDZ extra field.

    extraFieldZip64?: EntryExtraField

    The Zip64 extra field.

    filename: string

    The filename of the entry.

    filenameLength?: number

    The length of the filename in bytes.

    filenameUTF8: boolean

    true if the filename is encoded in UTF-8.

    gid?: number

    Unix group id when available.

    internalFileAttribute: number

    The internal file attribute (raw).

    Use EntryMetaData#internalFileAttributes instead.

    internalFileAttributes: number

    The internal file attributes (raw).

    lastAccessDate?: Date

    The last access date.

    lastModDate: Date

    The last modification date.

    localDirectory?: LocalDirectory

    The local file header fields, set when the entry data has been read.

    msdosAttributes?: {
        archive: boolean;
        directory: boolean;
        hidden: boolean;
        readOnly: boolean;
        system: boolean;
    }

    The MS-DOS attribute flags exposed as booleans.

    msdosAttributesRaw?: number

    The MS-DOS attributes low byte (raw). This is the low 8 bits of EntryMetaData#externalFileAttributes when present.

    msDosCompatible: boolean

    true if internalFileAttributes and externalFileAttributes are compatible with MS-DOS format.

    offset: number

    The byte offset of the entry.

    rawBitFlag?: number

    The general purpose bit flag (raw).

    rawComment: Uint8Array

    The comment of the entry (raw).

    rawCreationDate?: number | bigint

    The creation date (raw).

    rawExtraField: Uint8Array

    The extra field (raw).

    rawFilename: Uint8Array

    The filename of the entry (raw).

    rawLastAccessDate?: number | bigint

    The last access date (raw).

    rawLastModDate: number | bigint

    The last modification date (raw).

    setgid?: boolean

    true if the setgid bit is set on the entry.

    setuid?: boolean

    true if the setuid bit is set on the entry.

    signature: number

    The signature (CRC32 checksum) of the content.

    sticky?: boolean

    true if the sticky bit is set on the entry.

    uid?: number

    Unix owner id when available.

    uncompressedSize: number

    The size of the decompressed data in bytes.

    unixExternalUpper?: number

    The upper 16-bit portion of EntryMetaData#externalFileAttributes when it represents Unix mode bits.

    unixMode?: number

    Unix mode (st_mode) when available.

    version: number

    The "Version" field.

    versionMadeBy: number

    The "Version made by" field.

    zip64: boolean

    true if the entry is using Zip64.

    zipCrypto: boolean

    true if the content of the entry is encrypted with the ZipCrypto algorithm.

    Settings
    Member Visibility

    On This Page
    Properties