# imageurf

> Encode/Decode urf files

Latest version **0.1.3** (published 2017-11-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install imageurf
pnpm add imageurf
yarn add imageurf
bun add imageurf
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2017-11-05 |
| First published | 2017-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | David Dillkötter |
| Maintainers | dkdavid |

## Links

- npm: https://www.npmjs.com/package/imageurf
- Repository: https://github.com/DkDavid/imageurf
- Homepage: https://github.com/DkDavid/imageurf#readme
- Issues: https://github.com/DkDavid/imageurf/issues
- npm.io page: https://npm.io/package/imageurf

## Dependencies (1)

- [pngjs](https://npm.io/package/pngjs.md) ^3.3.0

## Recent versions

- 0.1.3 (latest) — 2017-11-05
- 0.1.2 — 2017-10-26
- 0.1.1 — 2017-10-26
- 0.1.0 — 2017-10-26

## README

imageurf
========

Encode or Decode urf data to build a AirPrint server or send pictures to AirPrint compatible printers.

Installation
===============
```
$ npm install imageurf  --save
```

Example
==========
```js
PNG = require('pngjs').PNG;
var fs = require('fs')

var Urf = require('imageurf')
var urf = new Urf()

var picture = [255, 255, 255, 0, 0, 0, 255, 255, 255 ] //RGB or greyscale pixel-array

var config = {
	width: 3, 				// width of picture
	height: 3, 				//height of picture
	greyScale: true, 		//Convert to greyscale, optional
	margin: {
		top: 5,
		bottom: 5,
		left: 5,
		right: 5
	}
}

urf.Encode(picture, config, function(buffer){

	urf.Decode(buffer, function(png){ //giving back an new PNG (see pngjs)
		png.pack()
		.pipe(fs.createWriteStream('newfile.png'))
		.on('finish', function() {
			console.log("Written to disk")
		});
	})
})
```

Changelog
============


### 0.1.0 - 26/10/2017
  - Initial, Encode function needs some optimization

Thanks
=======
Alan Quatermain for reverse engineering the urf image format 
https://github.com/AlanQuatermain/unirast

License
=========

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

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