Skip to content

59naga/pixel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pixel

Npm version Build Status

Get ImageData in cross-platform

Installation

for NodeJS

$ yarn add pixel
# or
$ npm install pixel --save

for Browser

<script src="https://unpkg.com/pixel"></script>
<script>
  console.log(pixel); //function
</script>

API

pixel(file) -> Promise<ImageData[]>

return images is Array contains one or more ImageData.

Return the object instead of ImageData at Node.js

file is...

  • string: url (e.g. http[s]://...)
  • string: datauri (e.g. data:image/...)
  • string: path (e.g. /path/to/file)
  • string: binary (unless above)
  • object: Blob/File
  • object: Buffer/ArrayBuffer/Uint8Array/Uint8ClampedArray
  • object: HTMLImageElement

Support

  • gif (static/animation)
  • png (static/animation)
  • jpeg
  • bitmap (24bit or less)
  • webp (static/animation)

Related projects

License

MIT