ZipEntry Node.js Reference Documentation

ZipEntry

Current Version: 10.1.2
Requires Chilkat Bundle License

Represents a single file or directory entry within a Chilkat Zip object. A zip entry can be one of 5 types (see the description of the EntryType property below).

Object Creation

var obj = new chilkat.ZipEntry();

Properties

Comment
Comment
· string

The comment stored within the Zip for this entry.

top
CompressedLength
CompressedLength
· integer, read-only

The size in bytes of this entry's file data when compression is applied

top
CompressedLength64
CompressedLength64
· 64-bit integer, read-only

The size in bytes of this entry's file data when compression is applied

top
CompressedLengthStr
CompressedLengthStr
· string, read-only

The size in decimal string format of this file when Zip compression is applied.

top
CompressionLevel
CompressionLevel
· integer

The compression level. 0 = no compression, while 9 = maximum compression. The default is 6.

top
CompressionMethod
CompressionMethod
· integer

Set to 0 for no compression, or 8 for the Deflate algorithm. The Deflate algorithm is the default algorithm of the most popular Zip utility programs, such as WinZip

top
Crc
Crc
· integer, read-only

The CRC for the zip entry. For AES encrypted entries, the CRC value will be 0. (See http://www.winzip.com/aes_info.htm#CRC )

top
DebugLogFilePath
DebugLogFilePath
· string

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
EncryptionKeyLen
EncryptionKeyLen
· integer, read-only
Introduced in version 9.5.0.69

If this entry is AES encrypted, then this property contains the AES key length (128, 192, or 256). If the entry is not AES encrypted, then the value is 0.

top
EntryID
EntryID
· integer, read-only

A unique ID assigned to the entry while the object is instantiated in memory.

top
EntryType
EntryType
· integer, read-only

Indicates the origin of the entry. There are three possible values:

  1. Mapped Entry: An entry in an existing Zip file.
  2. File Entry: A file not yet in memory, but referenced. These entries are added by calling AppendFiles, AppendFilesEx, AppendOneFileOrDir, etc.
  3. Data Entry: An entry containing uncompressed data from memory. These entries are added by calling AppendData, AppendString, etc.
  4. Null Entry: An entry that no longer exists in the .zip.
  5. New Directory Entry: A directory entry added by calling AppendNewDir.
When the zip is written by calling WriteZip or WriteToMemory, all of the zip entries are transformed into mapped entries. They become entries that contain the compressed data within the .zip that was just created. (The WriteZip method call effectively writes the zip and then opens it, replacing all of the existing entries with mapped entries.)

More Information and Examples
Zip Append Files and Entry Type
top
FileDateTimeStr
FileDateTimeStr
· string

The local last-modified date/time in RFC822 string format.

top
FileName
FileName
· string

The file name of the Zip entry.

More Information and Examples
Set Entry Filepath (in output Zip) when Zipping
top
FileNameHex
FileNameHex
· string, read-only

A string containing the hex encoded raw filename bytes found in the Zip entry.

top
IsAesEncrypted
IsAesEncrypted
· boolean, read-only
Introduced in version 9.5.0.69

true if the entry is AES encrypted. This property can only be true for entries already contained in a .zip (i.e. entries obtained from a zip archive that was opened via OpenZip, OpenBd, OpenFromMemory, etc.) The property is false if the entry contained in the zip is not AES encrypted.

top
IsDirectory
IsDirectory
· boolean, read-only

True if the Zip entry is a directory, false if it is a file.

top
LastErrorHtml
LastErrorHtml
· string, read-only

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
LastErrorText
· string, read-only

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
LastErrorXml
· string, read-only

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
LastMethodSuccess
· boolean

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
TextFlag
TextFlag
· boolean

Controls whether the "text flag" of the internal file attributes for this entry within the zip is set. This is a bit flag that indicates whether the file contents are text or binary. It is for informational use and it is not imperative that this bit flag is accurately set. The ability to set this bit flag is only provided to satisfy certain cases where another application might be sensitive to the flag.

top
UncompressedLength
UncompressedLength
· integer, read-only

The size in bytes of this entry's file data when uncompressed.

top
UncompressedLength64
UncompressedLength64
· 64-bit integer, read-only

The size in bytes of this entry's file data when uncompressed.

top
UncompressedLengthStr
UncompressedLengthStr
· string, read-only

The size in bytes (in decimal string format) of this zip entry's data when uncompressed.

top
VerboseLogging
VerboseLogging
· boolean

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version
· string, read-only

Version of the component/library, such as "10.1.0"

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

AppendData
var status = AppendData(inData);
· Returns Boolean (true for success, false for failure).
· inData Buffer

Appends binary data to the zip entry's file contents.

Returns true for success, false for failure.

top
AppendDataAsync (1)
var ret_task = AppendDataAsync(inData);
· Returns a Task
· inData Buffer

Creates an asynchronous task to call the AppendData method with the arguments provided.

Returns null on failure

top
AppendString
var status = AppendString(strContent, charset);
· Returns Boolean (true for success, false for failure).
· strContent String
· charset String

Appends text data to the zip entry's file contents. The text is appended using the character encoding specified by the charset, which can be "utf-8", "ansi", etc.

Returns true for success, false for failure.

top
AppendStringAsync (1)
var ret_task = AppendStringAsync(strContent, charset);
· Returns a Task
· strContent String
· charset String

Creates an asynchronous task to call the AppendString method with the arguments provided.

Returns null on failure

top
Copy
var retBuf = Copy();
· Returns a Buffer.

Returns the compressed data as a byte array.

Note: The Copy method can only be called if the zip entry already contains compressed data (i.e. it is a "mapped entry"). This is the case when an existing .zip is opened (from memory or from a file), or after the .zip has been written (by calling WriteZip or WriteToMemory). If a zip entry is created via AppendData, AppendFiles, etc., then it does not yet contain compressed data. When the zip is written, each entry becomes a "mapped entry" (The value of the EntryType property becomes 0.)

Returns null on failure

top
CopyToBase64
var retStr = CopyToBase64();
· Returns a String.

Returns the compressed data as a Base64-encoded string. It is only possible to retrieve the compressed data from a pre-existing .zip that has been opened or after writing the .zip but not closing it.

Note: The CopyToBase64 method can only be called if the zip entry already contains compressed data (i.e. it is a "mapped entry").

Returns null on failure

top
CopyToHex
var retStr = CopyToHex();
· Returns a String.

Returns the compressed data as a hexidecimal encoded string. It is only possible to retrieve the compressed data from a pre-existing .zip that has been opened or after writing the .zip but not closing it.

Note: The CopyToBase64 method can only be called if the zip entry already contains compressed data (i.e. it is a "mapped entry").

Returns null on failure

top
Extract
var status = Extract(dirPath);
· Returns Boolean (true for success, false for failure).
· dirPath String

Unzips this entry into the specified base directory. The file is unzipped to the subdirectory according to the relative path stored with the entry in the Zip. Use ExtractInto to unzip into a specific directory regardless of the path information stored in the Zip.

Returns true for success, false for failure.

top
ExtractAsync (1)
var ret_task = ExtractAsync(dirPath);
· Returns a Task
· dirPath String

Creates an asynchronous task to call the Extract method with the arguments provided.

Returns null on failure

top
ExtractInto
var status = ExtractInto(dirPath);
· Returns Boolean (true for success, false for failure).
· dirPath String

Unzip a file into a specific directory. If this entry is a directory, then nothing occurs. (An application can check the IsDirectory property and instead call Extract if it is desired to create the directory. )

Returns true for success, false for failure.

top
ExtractIntoAsync (1)
var ret_task = ExtractIntoAsync(dirPath);
· Returns a Task
· dirPath String

Creates an asynchronous task to call the ExtractInto method with the arguments provided.

Returns null on failure

top
GetDt
var ret_ckDateTime = GetDt();
· Returns a CkDateTime

Returns the last-modified date/time of this zip entry.

Returns null on failure

top
Inflate
var retBuf = Inflate();
· Returns a Buffer.

Inflate a file within a Zip directly into memory.

Returns null on failure

top
InflateAsync (1)
var ret_task = InflateAsync();
· Returns a Task

Creates an asynchronous task to call the Inflate method with the arguments provided.

Returns null on failure

top
LoadTaskCaller
var status = LoadTaskCaller(task);
· Returns Boolean (true for success, false for failure).
· task Task
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

top
NextEntry
var ret_zipEntry = NextEntry();
· Returns a ZipEntry

Return the next entry (file or directory) within the Zip

Returns null on failure

More Information and Examples
List Files in Zip using FirstEntry/NextEntry
top
NextMatchingEntry
var ret_zipEntry = NextMatchingEntry(matchStr);
· Returns a ZipEntry
· matchStr String
Introduced in version 9.5.0.50

Returns the next entry having a filename matching the matchStr. The "*" characters matches 0 or more of any character. The full filename, including path, is used when matching against the pattern.

Returns null on failure

More Information and Examples
Iterate over Matching Filenames
top
ReplaceData
var status = ReplaceData(inData);
· Returns Boolean (true for success, false for failure).
· inData Buffer

Replaces the zip entry's existing contents with new data.

Returns true for success, false for failure.

top
ReplaceString
var status = ReplaceString(strContent, charset);
· Returns Boolean (true for success, false for failure).
· strContent String
· charset String

Replaces the zip entry's existing contents with new text data. The text will be stored using the character encoding as specified by charset, which can be "utf-8", "ansi", etc.

Returns true for success, false for failure.

More Information and Examples
Replace/Update a FIle in a .zip
top
SetDt
SetDt(dt);
· Does not return anything (returns Undefined).
· dt CkDateTime

Sets the last-modified date/time for this zip entry.

top
UnzipToBd
var status = UnzipToBd(binData);
· Returns Boolean (true for success, false for failure).
· binData BinData
Introduced in version 9.5.0.67

Unzips the entry contents into the binData.

Returns true for success, false for failure.

top
UnzipToBdAsync (1)
var ret_task = UnzipToBdAsync(binData);
· Returns a Task
· binData BinData
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToBd method with the arguments provided.

Returns null on failure

top
UnzipToSb
var status = UnzipToSb(lineEndingBehavior, srcCharset, sb);
· Returns Boolean (true for success, false for failure).
· lineEndingBehavior Number
· srcCharset String
· sb StringBuilder
Introduced in version 9.5.0.67

Unzips a text file to the sb. The contents of sb are appended with the unzipped file. The lineEndingBehavior is as follows:

0 = leave unchanged.
1 = convert all to bare LF's
2 = convert all to CRLF's

The srcCharset tells the component how to interpret the bytes of the uncompressed file -- i.e. as utf-8, utf-16, windows-1252, etc.

Returns true for success, false for failure.

top
UnzipToSbAsync (1)
var ret_task = UnzipToSbAsync(lineEndingBehavior, srcCharset, sb);
· Returns a Task
· lineEndingBehavior Number
· srcCharset String
· sb StringBuilder
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToSb method with the arguments provided.

Returns null on failure

top
UnzipToStream
var status = UnzipToStream(toStream);
· Returns Boolean (true for success, false for failure).
· toStream Stream
Introduced in version 9.5.0.67

Unzips a file within a Zip to a stream. If called synchronously, the toStream must have a sink, such as a file or another stream object. If called asynchronously, then the foreground thread can read the stream.

Returns true for success, false for failure.

More Information and Examples
Unzip Binary File to Stream
top
UnzipToStreamAsync (1)
var ret_task = UnzipToStreamAsync(toStream);
· Returns a Task
· toStream Stream
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToStream method with the arguments provided.

Returns null on failure

More Information and Examples
Unzip One File to a Stream
top
UnzipToString
var retStr = UnzipToString(lineEndingBehavior, srcCharset);
· Returns a String.
· lineEndingBehavior Number
· srcCharset String

Inflate and return the uncompressed data as a string The lineEndingBehavior is as follows:

0 = leave unchanged.
1 = convert all to bare LF's
2 = convert all to CRLF's

The srcCharset tells the component how to interpret the bytes of the uncompressed file -- i.e. as utf-8, utf-16, windows-1252, etc.

Returns null on failure

More Information and Examples
Iterate over Matching FilenamesDownload a Zip from a URL and OpenFromMemory. (No .zip fie is created)
top
UnzipToStringAsync (1)
var ret_task = UnzipToStringAsync(lineEndingBehavior, srcCharset);
· Returns a Task
· lineEndingBehavior Number
· srcCharset String

Creates an asynchronous task to call the UnzipToString method with the arguments provided.

Returns null on failure

top