- Table of contents
- Overview
- Performance Warning
- Supported Image Formats
- Documentation
- Contributing
- Links
image-in-browser is an NPM package providing the ability to load, manipulate and save images of various image file formats.
- works both in Node.js and in the browser (no need for server-side Node.js)
- written entirely in Typescript with transpiling into Javascript
- doesn't have any dependencies on other packages
- is a full-fledged modern ES (ECMAScript) module
This library may be especially useful when you need to work with static or animated images directly in the browser code when the code is isolated from the system it's running on.
The following formats are currently supported for encoding / decoding:
Read / Write
- BMP
- GIF, animated GIF
- ICO
- JPG
- PNG, animated APNG
- TGA
- PVR
- TIFF
Read Only
- PNM, PBM, PGM, PPM
- PSD
- WEBP, animated WEBP
Write Only
- CUR
You can see examples of using this library by checking out the repository that was specifically created for publishing code examples there:
image-in-browser.examples (GitHub)
It will be supplemented and updated over time.
Since this library is written entirely in Typescript and is not a native executable library, its performance will not be as fast as a the native library.
To view the documentation for the package, please go to the Wiki.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
To contribute:
- Fork the project
- Create your feature branch (git checkout -b feature/AmazingFeature)
- ! Run the script
npm run buildto bring the code up to project standards - ! Fix all errors and warnings associated with your changes
- Commit your changes (git commit -m 'Add some AmazingFeature')
- Push to the branch (git push origin feature/AmazingFeature)
- Open a Pull Request
I will be very grateful for your support.
Link to NPM repository:
