KWAJ API Reference

Purpose

API reference for [Cabriolet::KWAJ::Decompressor](lib/cabriolet/kwaj/decompressor.rb) and [Cabriolet::KWAJ::Compressor](lib/cabriolet/kwaj/compressor.rb) classes for KWAJ compressed files.

References

KWAJ::Decompressor

Constructor

new(source, options = {})

Parameters: * source (String, IO, Handle) - KWAJ file path or handle

Example:

decompressor = Cabriolet::KWAJ::Decompressor.new('file.kwj')

Instance Methods

header

Returns KWAJ header.

Returns: [Cabriolet::Models::KWAJHeader](lib/cabriolet/models/kwaj_header.rb)

extract(output_path)

Decompresses file.

Parameters: * output_path (String) - Output path

extract_to_memory

Decompresses to memory.

Returns: String (binary)

KWAJ::Compressor

Constructor

new(options = {})

Options: * :compression_mode (Symbol) - Compression mode

Instance Methods

compress(input_path, output_path)

Compresses a file.

Bibliography

  • Microsoft KWAJ Format Documentation