Interface Entry

Represents an entry with its data and metadata in a zip file (Core API).

interface Entry {
    comment: string;
    commentUTF8: boolean;
    compressedSize: number;
    compressionMethod: number;
    creationDate?: Date;
    directory: boolean;
    diskNumberStart: number;
    encrypted: boolean;
    externalFileAttribute: number;
    extraField?: Map<number, {
        data: Uint8Array;
        type: number;
    }>;
    filename: string;
    filenameUTF8: boolean;
    internalFileAttribute: number;
    lastAccessDate?: Date;
    lastModDate: Date;
    msDosCompatible: boolean;
    offset: number;
    rawComment: Uint8Array;
    rawCreationDate?: number | bigint;
    rawExtraField: Uint8Array;
    rawFilename: Uint8Array;
    rawLastAccessDate?: number | bigint;
    rawLastModDate: number | bigint;
    signature: number;
    uncompressedSize: number;
    version: number;
    versionMadeBy: number;
    zip64: boolean;
    zipCrypto: boolean;
    getData?<Type>(writer:
        | WritableStream<any>
        | WritableWriter
        | AsyncGenerator<WritableStream<any> | WritableWriter | Writer<unknown>, boolean, any>
        | Writer<Type>, options?: EntryGetDataCheckPasswordOptions): Promise<Type>;
}

Hierarchy (view full)

Properties

comment commentUTF8 compressedSize compressionMethod creationDate? directory diskNumberStart encrypted externalFileAttribute extraField? filename filenameUTF8 internalFileAttribute lastAccessDate? lastModDate msDosCompatible offset rawComment rawCreationDate? rawExtraField rawFilename rawLastAccessDate? rawLastModDate signature uncompressedSize version versionMadeBy zip64 zipCrypto

Methods

getData?

Properties

comment

comment: string

The comment of the entry.

commentUTF8

commentUTF8: boolean

true if the comment is encoded in UTF-8.

compressedSize

compressedSize: number

The size of the compressed data in bytes.

compressionMethod

compressionMethod: number

The compression method.

OptionalcreationDate

creationDate?: Date

The creation date.

directory

directory: boolean

true if the entry is a directory.

diskNumberStart

diskNumberStart: number

The number of the disk where the entry data starts.

encrypted

encrypted: boolean

true if the content of the entry is encrypted.

externalFileAttribute

externalFileAttribute: number

The external file attribute (raw).

OptionalextraField

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

The extra field.

filename

filename: string

The filename of the entry.

filenameUTF8

filenameUTF8: boolean

true if the filename is encoded in UTF-8.

internalFileAttribute

internalFileAttribute: number

The internal file attribute (raw).

OptionallastAccessDate

lastAccessDate?: Date

The last access date.

lastModDate

lastModDate: Date

The last modification date.

msDosCompatible

msDosCompatible: boolean

true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.

offset

offset: number

The byte offset of the entry.

rawComment

rawComment: Uint8Array

The comment of the entry (raw).

OptionalrawCreationDate

rawCreationDate?: number | bigint

The creation date (raw).

rawExtraField

rawExtraField: Uint8Array

The extra field (raw).

rawFilename

rawFilename: Uint8Array

The filename of the entry (raw).

OptionalrawLastAccessDate

rawLastAccessDate?: number | bigint

The last access date (raw).

rawLastModDate

rawLastModDate: number | bigint

The last modification date (raw).

signature

signature: number

The signature (CRC32 checksum) of the content.

uncompressedSize

uncompressedSize: number

The size of the decompressed data in bytes.

version

version: number

The "Version" field.

versionMadeBy

versionMadeBy: number

The "Version made by" field.

zip64

zip64: boolean

true if the entry is using Zip64.

zipCrypto

zipCrypto: boolean

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

Methods

OptionalgetData

Settings

Member Visibility

On This Page

Properties
Methods