# pixel-bmp

> Parse Bitmap to ImageData in cross-platform

Latest version **0.0.1** (published 2015-11-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install pixel-bmp
pnpm add pixel-bmp
yarn add pixel-bmp
bun add pixel-bmp
```

## 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.0.1 |
| Published | 2015-11-01 |
| First published | 2015-06-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | 59naga |
| Maintainers | 59naga |
| Keywords | pixel, bmp |

## Links

- npm: https://www.npmjs.com/package/pixel-bmp
- Repository: https://github.com/59naga/pixel-bmp
- Homepage: https://github.com/59naga/pixel-bmp#readme
- Issues: https://github.com/59naga/pixel-bmp/issues
- npm.io page: https://npm.io/package/pixel-bmp

## Dependencies (2)

- [bmp-js](https://npm.io/package/bmp-js.md) ^0.0.1
- [pixel-util](https://npm.io/package/pixel-util.md) ^0.0.2

## Recent versions

- 0.0.1 (latest) — 2015-11-01
- 0.0.0 — 2015-11-01
- 0.0.0-alpha.3 — 2015-06-17
- 0.0.0-alpha.2 — 2015-06-09
- 0.0.0-alpha.1 — 2015-06-02
- 0.0.0-alpha.0 — 2015-06-01

## README

# pixelBitmap [![NPM version][npm-image]][npm] [![Build Status][travis-image]][travis] [![Coverage Status][coveralls-image]][coveralls]

[![Sauce Test Status][sauce-image]][sauce]

> Parse Bitmap to ImageData in cross-platform.

## Installation
```bash
$ npm install pixel-bmp --save
```
```js
var pixelBitmap= require('pixel-bmp');
console.log(pixelBitmap); //object
```

# API

## pixelBitmap.parse(`file`) -> promise.then(`images`)

return `images` is Array contains one or more `ImageData`.
> Return the `object` instead of `ImageData` in Node.js

```js
var file= 'https://59naga.github.io/fixtures/still.BMP';

pixelBitmap.parse(file).then(function(images){
  console.log(images[0]);
});
// {width: 128, height: 128, data: <Uint8Array ..>}
```

# Unsupport
* __32bit bitmap__

# Related projects
* [pixel-util](https://github.com/59naga/pixel-util/)
* [pixel-gif](https://github.com/59naga/pixel-gif-/)
* [pixel-png](https://github.com/59naga/pixel-png/)
* [pixel-jpg](https://github.com/59naga/pixel-jpg/)
* __pixel-bmp__
* [pixel](https://github.com/59naga/pixel/)
* [pixel-to-ansi](https://github.com/59naga/pixel-to-ansi/)
* [pixel-to-svg](https://github.com/59naga/pixel-to-svg/)

License
---
[MIT][License]

[License]: http://59naga.mit-license.org/

[sauce-image]: http://soysauce.berabou.me/u/59798/pixel-bmp.svg?large
[sauce]: https://saucelabs.com/u/59798
[npm-image]:https://img.shields.io/npm/v/pixel-bmp.svg?style=flat-square
[npm]: https://npmjs.org/package/pixel-bmp
[travis-image]: http://img.shields.io/travis/59naga/pixel-bmp.svg?style=flat-square
[travis]: https://travis-ci.org/59naga/pixel-bmp
[coveralls-image]: http://img.shields.io/coveralls/59naga/pixel-bmp.svg?style=flat-square
[coveralls]: https://coveralls.io/r/59naga/pixel-bmp?branch=master

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