UnixCompress Node.js Reference Documentation

UnixCompress

Current Version: 10.1.2

Requires Chilkat Bundle License

UNIX (.Z) compression component.

Object Creation

var obj = new chilkat.UnixCompress();

Properties

AbortCurrent

AbortCurrent

· boolean

Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

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.

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.

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 LastErrorText LastErrorText Standard Information

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.

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.

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.

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.

Methods

CompressFile

var status = CompressFile(inFilename, destPath);

· Returns Boolean (true for success, false for failure).
· inFilename String
· destPath String

Compresses a file to create a UNIX compressed file (.Z). This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.

Returns true for success, false for failure.

CompressFileAsync ⁽¹⁾

var ret_task = CompressFileAsync(inFilename, destPath);

· Returns a Task
· inFilename String
· destPath String

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

Returns null on failure

CompressFileToMem

var retBuf = CompressFileToMem(inFilename);

· Returns a Buffer.

Unix compresses a file to an in-memory image of a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns null on failure

CompressFileToMemAsync ⁽¹⁾

var ret_task = CompressFileToMemAsync(inFilename);

· Returns a Task
· inFilename String

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

Returns null on failure

CompressMemory

var retBuf = CompressMemory(inData);

· Returns a Buffer.

Compresses in-memory data to an in-memory image of a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns null on failure

CompressMemToFile

var status = CompressMemToFile(inData, destPath);

· Returns Boolean (true for success, false for failure).
· inData Buffer
· destPath String

Unix compresses and creates a .Z file from in-memory data. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

CompressString

var retBuf = CompressString(inStr, charset);

· Returns a Buffer.

Compresses a string to an in-memory image of a .Z file. Prior to compression, the string is converted to the character encoding specified by charset. The charset can be any one of a large number of character encodings, such as "utf-8", "iso-8859-1", "Windows-1252", "ucs-2", etc.

Returns null on failure

More Information and Examples

List of Valid Charsets

CompressStringToFile

var status = CompressStringToFile(inStr, charset, destPath);

· Returns Boolean (true for success, false for failure).
· inStr String
· charset String
· destPath String

Unix compresses and creates a .Z file from string data. The charset specifies the character encoding used for the byte representation of the characters when compressed. The charset can be any one of a large number of character encodings, such as "utf-8", "iso-8859-1", "Windows-1252", "ucs-2", etc.

Returns true for success, false for failure.

More Information and Examples

List of Valid Charsets

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.

UncompressFile

var status = UncompressFile(inFilename, destPath);

· Returns Boolean (true for success, false for failure).
· inFilename String
· destPath String

Uncompresses a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

UncompressFileAsync ⁽¹⁾

var ret_task = UncompressFileAsync(inFilename, destPath);

· Returns a Task
· inFilename String
· destPath String

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

Returns null on failure

UncompressFileToMem

var retBuf = UncompressFileToMem(inFilename);

· Returns a Buffer.

Uncompresses a .Z file directly to memory. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns null on failure

UncompressFileToMemAsync ⁽¹⁾

var ret_task = UncompressFileToMemAsync(inFilename);

· Returns a Task
· inFilename String

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

Returns null on failure

UncompressFileToString

var retStr = UncompressFileToString(zFilename, charset);

· Returns a String.
· zFilename String
· charset String

Uncompresses a .Z file that contains a text file. The contents of the text file are returned as a string. The character encoding of the text file is specified by charset. Typical charsets are "iso-8859-1", "utf-8", "windows-1252", "shift_JIS", "big5", etc.

Returns null on failure

More Information and Examples

List of Valid Charsets

UncompressFileToStringAsync ⁽¹⁾

var ret_task = UncompressFileToStringAsync(zFilename, charset);

· Returns a Task
· zFilename String
· charset String

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

Returns null on failure

UncompressMemory

var retBuf = UncompressMemory(inData);

· Returns a Buffer.

Uncompresses from an in-memory image of a .Z file directly into memory. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns null on failure

UncompressMemToFile

var status = UncompressMemToFile(inData, destPath);

· Returns Boolean (true for success, false for failure).
· inData Buffer
· destPath String

Uncompresses from an in-memory image of a .Z file to a file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

UncompressString

var retStr = UncompressString(inCompressedData, charset);

· Returns a String.
· inCompressedData Buffer
· charset String

Uncompresses from an in-memory image of a .Z file directly to a string. The charset specifies the character encoding used to interpret the bytes resulting from the decompression. The charset can be any one of a large number of character encodings, such as "utf-8", "iso-8859-1", "Windows-1252", "ucs-2", etc.

Returns null on failure

More Information and Examples

List of Valid Charsets

UnTarZ

var status = UnTarZ(zFilename, destDir, bNoAbsolute);

· Returns Boolean (true for success, false for failure).
· zFilename String
· destDir String
· bNoAbsolute Boolean

Unpacks a .tar.Z file. The decompress and untar occur in streaming mode. There are no temporary files and the memory footprint is constant (and small) while untarring.

Returns true for success, false for failure.

UnTarZAsync ⁽¹⁾

var ret_task = UnTarZAsync(zFilename, destDir, bNoAbsolute);

· Returns a Task
· zFilename String
· destDir String
· bNoAbsolute Boolean

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

Returns null on failure