@volue/wasm-codecs-oxipng
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

@wasm-codecs/oxipng npm version license downloads

Oxipng WebAssembly Codec

Table of contents

  1. Installation
  2. Usage
  3. API
  4. Examples
  5. License

Installation

npm install @wasm-codecs/oxipng

Requirements:

  • Node.js 10 or later

Usage

import encode from '@wasm-codecs/oxipng';

(async () => {
  const encodedImage = await encode(image, encodeOptions);
})();

API

encode(image, encodeOptions?): Buffer

Returns a buffer containing the compressed image data.

image: Buffer

Buffer of a PNG image.

encodeOptions?: EncodeOptions

All encoding options are optional and fall back to the default values.

type EncodeOptions = {
  level?: number;
}

Examples

Using Node.js

import fs from 'fs';
import encode from '@wasm-codecs/oxipng';

// read input image as a buffer
const data = fs.readFileSync('in.png');

// encode the image using @wasm-codecs/oxipng
const output = encode(data);

// save the image to the file system
fs.writeFileSync('out.png', output);

License

Licensed under the MIT license.

© Copyright Cyril Wanner

Package Sidebar

Install

npm i @volue/wasm-codecs-oxipng

Weekly Downloads

5

Version

1.0.1

License

MIT

Unpacked Size

338 kB

Total Files

11

Last publish

Collaborators

  • aleksanderxxx
  • fima1