dan/pngjs
1
0
Fork 0
mirror of https://github.com/danbulant/pngjs synced 2026-07-09 13:10:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clarified png.parse() (from @stevenvanchon)

Browse source
This commit is contained in:
Luke Page 2015-07-30 18:35:45 +01:00
parent dbe7fbe390
commit 4c508c661e
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -83,13 +83,20 @@ Input image has been completly parsed, `data` is complete and ready for modifica
### png.parse(data, [callback]) ### png.parse(data, [callback])
Parses PNG file data. Alternatively you can stream data to instance of PNG. Parses PNG file data. Can be `String` or `Buffer`. Alternatively you can stream data to instance of PNG.
Optional `callback` is once called on `error` or `parsed`. The callback gets Optional `callback` is once called on `error` or `parsed`. The callback gets
two arguments `(err, data)`. two arguments `(err, data)`.
Returns `this` for method chaining. Returns `this` for method chaining.
+#### Example
```js
new PNG({ filterType:4 }).parse( imageData, function(error, data)
{
console.log(error, data)
});
```
### png.pack() ### png.pack()
Starts converting data to PNG file Stream. Starts converting data to PNG file Stream.