Bz2 Node.js Reference Documentation

Bz2

Current Version: 10.1.0

Requires Chilkat Bundle License

Provides the ability to create and unzip .bz2 compressed files using the BZip2 compression algorithm.

Object Creation

var obj = new chilkat.Bz2();

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, toPath);

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

Compresses a file to create a BZip2 compressed file (.bz2).

Note: Both inFilename and toPath should be relative or absolute file paths (not just a path to a directory). For example "someDir1/someDir2/myFile.txt" or "c:/someDir1/myFile.bz2".

Returns true for success, false for failure.

More Information and Examples

bz2 Compress File

CompressFileAsync ⁽¹⁾

var ret_task = CompressFileAsync(inFilename, toPath);

· Returns a Task
· inFilename String
· toPath 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.

BZip2 compresses a file to an in-memory image of a .bz2 file.

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 .bz2 file.

Returns null on failure

CompressMemoryAsync ⁽¹⁾

var ret_task = CompressMemoryAsync(inData);

· Returns a Task
· inData Buffer

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

Returns null on failure

CompressMemToFile

var status = CompressMemToFile(inData, toPath);

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

BZip2 compresses and creates a .bz2 file from in-memory data.

Returns true for success, false for failure.

CompressMemToFileAsync ⁽¹⁾

var ret_task = CompressMemToFileAsync(inData, toPath);

· Returns a Task
· inData Buffer
· toPath String

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

Returns null on failure

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, toPath);

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

Unzips a .bz2 file.

Returns true for success, false for failure.

UncompressFileAsync ⁽¹⁾

var ret_task = UncompressFileAsync(inFilename, toPath);

· Returns a Task
· inFilename String
· toPath 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.

Unzips a .bz2 file directly to memory.

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

UncompressMemory

var retBuf = UncompressMemory(inData);

· Returns a Buffer.

Unzips from an in-memory image of a .bz2 file directly into memory.

Returns null on failure

UncompressMemoryAsync ⁽¹⁾

var ret_task = UncompressMemoryAsync(inData);

· Returns a Task
· inData Buffer

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

Returns null on failure

UncompressMemToFile

var status = UncompressMemToFile(inData, toPath);

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

Unzips from an in-memory image of a .bz2 file to a file.

Returns true for success, false for failure.

UncompressMemToFileAsync ⁽¹⁾

var ret_task = UncompressMemToFileAsync(inData, toPath);

· Returns a Task
· inData Buffer
· toPath String

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

Returns null on failure