Git Product home page Git Product logo

jsng's Introduction

jsng

jsng is a JS encoder/decoder for the ever-popular and inefficient JSON-G format.

JSON-G (JSON-Graphics) is an extremely inefficient way to store raster image data, with transparency and layered support!

Why jsng?

Using jsng allows you to combine the inefficiency and extensive features of JSON-G with the flexibility and ease-of-use of JavaScript, allowing you to seamlessly create and use JSON-G files wherever you are!

jsng is also the most efficient JSON-G library on the internet (as of 2017 February 15), outperforming any other encoder/decoder both in terms of speed and filesize.

Features

  • Support for an infinite number of layers
  • Support for optional transparency
  • Comment support for each individual pixel
  • Incredibly large filesizes (approximately 400x bigger than equivalent PNGs)
  • Human-readable formatting

Installation

npm install abalabahaha/jsng

API

The API is relatively simple, and has just two functions.

jsng.toJSNG(file, callback)

  • file - a string pointing to a JPG or PNG file
  • callback(err, jsng) - a callback function with the following parameters
    • err - an Error object, null if no error was encountered
    • jsng - an Object containing the JSON-G data for the image

jsng.fromJSNG(file, callback)

  • file - a string pointing to a JSNG file
  • callback(err, jsng) - a callback function with the following parameters
    • err - an Error object, null if no error was encountered
    • buffer - a Buffer containing the JPG or PNG data for the image
    • mimeType - a String containing the MIME type of the image

Example

See the examples folder for example decoder and encoder scripts.

Similar Projects

Reference

jsng's People

Contributors

abalabahaha avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.