# geometrizejs-extra

> Extra (high level APIs) for geometrizejs, suuports Node.js and Browser

Latest version **0.0.2** (published 2019-07-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install geometrizejs-extra
pnpm add geometrizejs-extra
yarn add geometrizejs-extra
bun add geometrizejs-extra
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2019-07-10 |
| First published | 2019-07-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 16.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Sebastián Gurin |
| Maintainers | cancerberosgx |

## Links

- npm: https://www.npmjs.com/package/geometrizejs-extra
- Repository: https://github.com/cancerberoSgx/geometrizejs
- Homepage: https://www.npmjs.com/package/geometrizejs-extra
- Issues: https://github.com/cancerberosgx/geometrizejs/issues
- npm.io page: https://npm.io/package/geometrizejs-extra

## Dependencies (6)

- [jimp](https://npm.io/package/jimp.md) ^0.6.4
- [mujer](https://npm.io/package/mujer.md) 0.0.5
- [cross-fetch](https://npm.io/package/cross-fetch.md) ^3.0.4
- [geometrizejs](https://npm.io/package/geometrizejs.md) 0.0.15
- [svg-png-converter](https://npm.io/package/svg-png-converter.md) 0.0.9
- [misc-utils-of-mine-generic](https://npm.io/package/misc-utils-of-mine-generic.md) ^0.2.15

## Recent versions

- 0.0.2 (latest) — 2019-07-10

## README

# geometrizejs-extra

Extra (High level APIs) for [geometrizejs](https://github.com/cancerberoSgx/geometrizejs).

<!-- toc -->

- [Features](#features)
- [Install](#install)
- [Usage](#usage)
- [Options](#options)
- [Related Projects](#related-projects)
- [TODO](#todo)

<!-- tocstop -->

## Features

 * JPG, PNG, TIFF, GIF, BMP input formats
 * SVG, JSON, JPEG, PNG output formats
 * optimized SVG ouptut
 * ImageRunner steps iteration implementation
 * API to control the steps iteration  

## Install

```sg
npm install geometrizejs-extra 
```

## Usage
```js
import {Geometrize} from 'geometrizejs-extra'
const job = new Geometrize({
  input: 'test/assets/bluebells.jpg',
  output: 'tmp/formUrl.svg',
  shapeTypes: [ShapeTypes.TRIANGLE],
  iterations: 1000,
  onFinish: result => {
    
  },
  onStep: step => {
    
  }
})
const r = await job.start()
```
## Options



## Related Projects

 * [geometrizejs](https://www.npmjs.com/package/geometrizejs) (the library in which this tool is based)
 * [geometrize-haxe](https://github.com/Tw1ddle/geometrize-haxe/) (the original library from which geometrizejs is built from)
 * [geometrizejs-cli](https://www.npmjs.com/package/geometrizejs-cli) (provides CLI using this library)
 * [magica](https://www.npmjs.com/package/magica)
 * [mujer](https://www.npmjs.com/package/mujer) provides SVG optimization tools
 
## TODO

- [ ] magica to more formats ?
- [ ] input from url
- [ ] document src/options.ts
- [ ] options in readme
- [x] browser tests
- [x] readme TOC
- [x] node.js tests
- [x] svg optimizer
- [x] use svg-to-png-converter to render bitmap formats

---
_Source: https://npm.io/package/geometrizejs-extra · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._