UnixCompress Node.js Reference Documentation

UnixCompress

Current Version: 9.5.0.97

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.)

top
DebugLogFilePath
DebugLogFilePath
· string

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
LastErrorHtml
· string, read-only

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText
· string, read-only

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml
· string, read-only

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess
· boolean

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

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 "9.5.0.94"

More Information and Examples
top

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.

top
CompressFileAsync (1)
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. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
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

top
CompressFileToMemAsync (1)
var ret_task = CompressFileToMemAsync(inFilename);
· Returns a Task
· inFilename String

Creates an asynchronous task to call the CompressFileToMem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
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

top
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.

top
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
top
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
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
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.

top
UncompressFileAsync (1)
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. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
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

top
UncompressFileToMemAsync (1)
var ret_task = UncompressFileToMemAsync(inFilename);
· Returns a Task
· inFilename String

Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
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
top
UncompressFileToStringAsync (1)
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. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
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

top
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.

top
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
top
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.

top
UnTarZAsync (1)
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. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top