Code Monkey home page Code Monkey logo

node-primitive's Introduction

code style: prettier

node-primitive

A port of primitive.js (primitive.lol) for Node.js thanks to the amazing jsdom library.

This library allow you to create an SVG representation of a given image using primitives.

Original PNG:329KB -> SVG(100 primitives):5KB -> SVG(10 primitives + blur): 600B

alt text alt text alt text

I don't like to install anything except nvm on my node projects. So I adapted primitive.js to work with Node.js in order to avoid having to install GO when using sqip.

Quick start

const { generateSVG } = require("./../src/api");
const { Triangle } = require("./../src/shape");

const cfg = {
  alpha: 0.5,
  computeSize: 256,
  fill: "rgb(244, 244, 244)",
  height: 256,
  mutateAlpha: true,
  mutations: 30,
  scale: 2,
  shapeTypes: [Triangle],
  shapes: 20,
  steps: 20,
  viewSize: 512,
  width: 256,
  blur: 35
};

const SVGString = await generateSVG("samples/profile.png", cfg);
// or
await generateSVG("samples/profile.png", cfg, "output.svg");

Warning

This script is really slow.

Running tests

Just run

yarn
jest

Debugging

You can use the env var "DEBUG" to display debug informations with the prefix "node-internal".

The "verbose" level will display stats about the generated file.

DEBUG=node-primitive:verbose jest

The "internal" level can be used to debug the library.

DEBUG=node-primitive:internal jest

Todo

  • Check why onStep is removed the result is bad
  • Remove promises, switch to await
  • Fix the exports to use default exports when only one function/class is exposed

Thanks

Thanks to José M. Pérez to have open my eyes on image placeholder generation.

References

node-primitive's People

Contributors

vincentdesmares avatar

Watchers

James Cloos avatar Vu Nguyen 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.