Neoteric Plumbing Mishap
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    @gfx/zopflipublic

    Universal Zopfli Build Status

    google/zopfli is a compression library to perform gzip, deflate or zlib compression.

    This library is a JavaScript binding to zopfli with WebAssembly. This might be slower than C/C++ extension for zopfli, but because wasm is portable binary its installation is much easier than C/C++ extensions.

    Installation

    # for npm users:
    npm install "@gfx/zopfli"
     
    # for yarnpkg users
    yarnpkg add "@gfx/zopfli"

    Usage

    In TypeScript:

    import { gzip } from "@gfx/zopfli";
     
    const input: string;
    gzip(input, { numiterations: 15 }, (err, output) => {
        // output is compressed in gzip
    });

    Note that the gzip method is compatible with node-zopfli.

    Options

    Exported as ZopfliOptions and its default is:

    const defaultOptions: ZopfliOptions = {
        verbose: false,
        verbose_more: false,
        numiterations: 15,
        blocksplitting: true,
        blocksplittingmax: 15,
    };

    Development

    Prerequisites

    Testing

    make

    Benchmarking

    make benchmark-with-optimization

    As of emscripten 1.37.28 + NodeJS 9.4.0 + macOS 10.12.6, the result is as follows:

    ## payload size: 1
    universal-zopfli x 94.09 ops/sec ±5.51% (71 runs sampled)
    node-zopfli x 196 ops/sec ±4.22% (81 runs sampled)
    Fastest is node-zopfli
    ## payload size: 1024
    universal-zopfli x 1.68 ops/sec ±1.35% (13 runs sampled)
    node-zopfli x 5.15 ops/sec ±0.69% (29 runs sampled)
    Fastest is node-zopfli
    ## payload size: 1038336
    universal-zopfli x 0.29 ops/sec ±2.75% (6 runs sampled)
    node-zopfli x 0.39 ops/sec ±2.34% (6 runs sampled)
    Fastest is node-zopfli
    

    That is, the performance of universal-zopfli is about 70% of native binding node-zopfli with 1MB payload.

    See Also

    Copyright

    Copyright 2017, FUJI Goro (gfx).

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0
    

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    And it links to google/zopfli statically, which is also licensed by Google under Apache 2.0 License.

    install

    npm i @gfx/zopfli

    Downloadsweekly downloads

    49

    version

    1.0.8

    license

    Apache-2.0

    repository

    githubgithub

    last publish

    collaborators

    • avatar