1. module node-zopfli
   1. function node-zopfli (format, options)
   2. function node-zopfli.compress (buffer, type, options, callback)
   3. function node-zopfli.createDeflate (options)
   4. function node-zopfli.createGzip (options)
   5. function node-zopfli.createZlib (options)
   6. function node-zopfli.deflate (buffer, options, callback)
   7. function node-zopfli.deflateSync (buffer, options)
   8. function node-zopfli.gzip (buffer, options, callback)
   9. function node-zopfli.gzipSync (buffer, options)
   10. function node-zopfli.super_ (options)
   11. function node-zopfli.zlib (buffer, options, callback)
   12. function node-zopfli.zlibSync (buffer, options)

module node-zopfli

function node-zopfli (format, options)

• description and source-code

  function Zopfli(format, options) {
    this.first = true;
    this.adler = 0x01;
    this.crc = null;
    this.format = format || 'deflate';
    this.options = defaults(options, defaultOptions);
    this.in = new Buffer(0);
    Transform.prototype.constructor.apply(this, arguments);
  }

• example usage

  n/a

function node-zopfli.compress (buffer, type, options, callback)

• description and source-code

  compress = function (buffer, type, options, callback) {
    if (typeof callback === 'undefined' && typeof options === 'function') {
      callback = options;
      options = {};
    }
    options = options || {};
    if (typeof callback === 'function') {
      zopfli.deflate(buffer, type, options, callback);
    } else {
      return new Promise(function(resolve, reject) {
        zopfli.deflate(buffer, type, options, function(err, data) {
          if (err) {
            reject(err);
          } else {
            resolve(data);
          }
        });
      });
    }
  }

• example usage

  ...
          }
        });
      });
    }
  };
  
  Zopfli.gzip = function(buffer, options, callback) {
    return Zopfli.compress(buffer, 'gzip', options, callback);
  };
  
  Zopfli.zlib = function(buffer, options, callback) {
    return Zopfli.compress(buffer, 'zlib', options, callback);
  };
  
  Zopfli.deflate = function(buffer, options, callback) {
  ...

function node-zopfli.createDeflate (options)

• description and source-code

  createDeflate = function (options) {
    return new Zopfli('deflate', options);
  }

• example usage

  n/a

function node-zopfli.createGzip (options)

• description and source-code

  createGzip = function (options) {
    return new Zopfli('gzip', options);
  }

• example usage

  ...
  
  ### Usage examples
  #### Stream (async):
  
  ```js
  var zopfli = require('node-zopfli');
  fs.createReadStream('file.js')
    .pipe(zopfli.createGzip(options))
    .pipe(fs.createWriteStream('file.js.gz'));
  ```
  
  Instead of `zopfli.createGzip`, you can also use
  
  ```js
  new Zopfli('gzip', options);
  ...

function node-zopfli.createZlib (options)

• description and source-code

  createZlib = function (options) {
    return new Zopfli('zlib', options);
  }

• example usage

  n/a

function node-zopfli.deflate (buffer, options, callback)

• description and source-code

  deflate = function (buffer, options, callback) {
    return Zopfli.compress(buffer, 'deflate', options, callback);
  }

• example usage

  ...
  ```
  
  #### Buffer (async):
  
  ```js
  var zopfli = require('node-zopfli');
  var input = new Buffer('I want to be compressed');
  zopfli.deflate(input, options, function(err, deflated) {});
  zopfli.zlib(input, options, function(err, zlibed) {});
  zopfli.gzip(input, options, function(err, gziped) {});
  ```
  
  #### Buffer (sync):
  
  ```js
  ...

function node-zopfli.deflateSync (buffer, options)

• description and source-code

  deflateSync = function (buffer, options) {
    return zopfli.deflateSync(buffer, 'deflate', options);
  }

• example usage

  ...
  ```
  
  #### Buffer (sync):
  
  ```js
  var zopfli = require('node-zopfli');
  var input = new Buffer('I want to be compressed');
  var deflated = zopfli.deflateSync(input, options);
  var zlibed = zopfli.zlibSync(input, options);
  var gziped = zopfli.gzipSync(input, options);
  ```
  
  ### API
  
  #### compress(input, format, [options, callback])
  ...

function node-zopfli.gzip (buffer, options, callback)

• description and source-code

  gzip = function (buffer, options, callback) {
    return Zopfli.compress(buffer, 'gzip', options, callback);
  }

• example usage

  ...
  #### Buffer (async):
  
  ```js
  var zopfli = require('node-zopfli');
  var input = new Buffer('I want to be compressed');
  zopfli.deflate(input, options, function(err, deflated) {});
  zopfli.zlib(input, options, function(err, zlibed) {});
  zopfli.gzip(input, options, function(err, gziped) {});
  ```
  
  #### Buffer (sync):
  
  ```js
  var zopfli = require('node-zopfli');
  var input = new Buffer('I want to be compressed');
  ...

function node-zopfli.gzipSync (buffer, options)

• description and source-code

  gzipSync = function (buffer, options) {
    return zopfli.deflateSync(buffer, 'gzip', options);
  }

• example usage

  ...
  #### Buffer (sync):
  
  ```js
  var zopfli = require('node-zopfli');
  var input = new Buffer('I want to be compressed');
  var deflated = zopfli.deflateSync(input, options);
  var zlibed = zopfli.zlibSync(input, options);
  var gziped = zopfli.gzipSync(input, options);
  ```
  
  ### API
  
  #### compress(input, format, [options, callback])
  
  `input` is the input buffer
  ...

function node-zopfli.super_ (options)

• description and source-code

  function Transform(options) {
    if (!(this instanceof Transform))
      return new Transform(options);
  
    Duplex.call(this, options);
  
    this._transformState = new TransformState(this);
  
    var stream = this;
  
    // start out asking for a readable event once data is transformed.
    this._readableState.needReadable = true;
  
    // we have implemented the _read method, and done the other things
    // that Readable wants before the first _read call, so unset the
    // sync guard flag.
    this._readableState.sync = false;
  
    if (options) {
      if (typeof options.transform === 'function')
        this._transform = options.transform;
  
      if (typeof options.flush === 'function')
        this._flush = options.flush;
    }
  
    // When the writable side finishes, then flush out anything remaining.
    this.once('prefinish', function() {
      if (typeof this._flush === 'function')
        this._flush(function(er) {
          done(stream, er);
        });
      else
        done(stream);
    });
  }

• example usage

  n/a

function node-zopfli.zlib (buffer, options, callback)

• description and source-code

  zlib = function (buffer, options, callback) {
    return Zopfli.compress(buffer, 'zlib', options, callback);
  }

• example usage

  ...
  
  #### Buffer (async):
  
  ```js
  var zopfli = require('node-zopfli');
  var input = new Buffer('I want to be compressed');
  zopfli.deflate(input, options, function(err, deflated) {});
  zopfli.zlib(input, options, function(err, zlibed) {});
  zopfli.gzip(input, options, function(err, gziped) {});
  ```
  
  #### Buffer (sync):
  
  ```js
  var zopfli = require('node-zopfli');
  ...

function node-zopfli.zlibSync (buffer, options)

• description and source-code

  zlibSync = function (buffer, options) {
    return zopfli.deflateSync(buffer, 'zlib', options);
  }

• example usage

  ...
  
  #### Buffer (sync):
  
  ```js
  var zopfli = require('node-zopfli');
  var input = new Buffer('I want to be compressed');
  var deflated = zopfli.deflateSync(input, options);
  var zlibed = zopfli.zlibSync(input, options);
  var gziped = zopfli.gzipSync(input, options);
  ```
  
  ### API
  
  #### compress(input, format, [options, callback])
  ...