{"_id":"bmp-ts","_rev":"27-5dcd1bce15db9f2236eb48111ebe2fbf","name":"bmp-ts","dist-tags":{"canary":"1.0.4-canary.f6048cc","latest":"1.0.9"},"versions":{"0.2.6-canary.36ca5a2":{"name":"bmp-ts","version":"0.2.6-canary.36ca5a2","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"gitHead":"36ca5a2982eca5d1865460b89db89c309212cf56","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@0.2.6-canary.36ca5a2","_nodeVersion":"12.10.0","_npmVersion":"6.10.3","dist":{"integrity":"sha512-vYezwJnyL7rmKKNnTZEPF8voptG27rCLCGMVlOHxrPEdYVi2qLSaI+jrfHPL0VuHuVvD6FYqiVFMAJZngg16LQ==","shasum":"deaf7f5632a9bba25be7e0cb02e9a2824460768a","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-0.2.6-canary.36ca5a2.tgz","fileCount":18,"unpackedSize":64814,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdg+IMCRA9TVsSAnZWagAA29EP/RW8boNS4nsMUUjwist8\nYBsljmahckd7YLQwn3u4V0ctqSKFLAxSGr3H6yvzDqn+OxDzsY5cIL765IeA\npuxTjYmwAqB5Y1/wB3CUqf2PFoE5XYGLHtpOoNb/lACQQAslSv+3R4xU0VC4\n5Vy6l5l0IF0xZStvBZ2XJGCmCZlZIuwsFujyDrsydayM6NWEsldVaRNx2Xda\nE3Pggfkrr+tvbPQpFMhygoy72xw+S1vN248DxGyeG2NUT72AD57NmxokqQwx\n16CVDwuQ9k2Du38AdIDuwAPwVZhpxCiTZRirDzXZN/bM7E+NwiVPbfzfljMh\nz0DUl+jkW0BxlY3YpNgdwCb8bdqWs39ab96FNnQZY12zGGkZqcj9Zf6k2TwJ\n9NowlHtKi1rcGBkx9cgEGx1hFW1u44QePNU5/8meGCGbnq6a3w3xpbHaCr+w\nMQoGZxFMY5esZri3S0sMbHLKs5TQcVN8Ccp0c9EkUukEPnmpig0uoq7GlWAG\n+RNDR9CrG3xFdGb+5+OtuJIVNvnzEKg5aoBdrWJyAEe73HMdv9bSDZeixvDn\n1Cg/xZJjc25pqtrhcL155Gm5PQVm1ksnCV1RdV9BqtESGy9FsXUqNiG79KFj\nwMn+V0OvQQ9qK+DC/VbuxzNexc2Js+gzG1n0ytDFRFSAMW4XXU7zkNzJlj2a\now2L\r\n=UlzQ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC1ouPK4zYj1nPMS1BGmJQktDw97huF6Dk547YPyMN4LAIgVCo/NEfKSmyEoChEStrqZpojgPJ4zRaIXeCBKqvCuD4="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_0.2.6-canary.36ca5a2_1568924171643_0.20189420816370207"},"_hasShrinkwrap":false},"0.2.6-canary.0017be3":{"name":"bmp-ts","version":"0.2.6-canary.0017be3","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![CircleCI](https://img.shields.io/circleci/project/github/hipstersmoothie/bmp-ts/master.svg?style=for-the-badge)](https://circleci.com/gh/hipstersmoothie/bmp-ts) [![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"0017be388adc0619017c711567a5dda150542066","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@0.2.6-canary.0017be3","_nodeVersion":"12.10.0","_npmVersion":"6.10.3","dist":{"integrity":"sha512-tBr6yitDDTwNf5OXH33TxZ9sAIny6y8wPEXmHpCACxGb+5YCdyI8N+hOw4qsX5jF4kuWfvbsKAOA3lh830TckA==","shasum":"49f902ed6d532797ee171e702fd03f68fc8a2f31","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-0.2.6-canary.0017be3.tgz","fileCount":18,"unpackedSize":64814,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdg+ITCRA9TVsSAnZWagAAD88QAIs/vttd4+1jFs+4Usii\nWNZomCQbjd6ULEMBN/7TB71yrO6NPglsv9GRBLG0gbi1HBJopozfZ+GCYHx1\nMeBXcrQ0r9bChDVWMfAT+fRgZI1xZsGf16oexzGK+9uE3+HA5Vqnt+zHdxh1\nW+NqIa/kkPjob/vlaYqJk3rNT1dTcPbgyhGcSXVS9jaiRH+wNMMmlc8kwCgd\nLXbRC836Awoo71vvG5oEnEtBuheVAtL3H/MmZwyU1kf9ml3cYVBEFZcUdi9b\nWMSE3qwz81yquMWM4a1Efsm7Jzd3fq1rFJ5XNIHb/8ufP7Ttomg8JgwCYUZQ\nqskfED+z7TcMyJMieuUXC/NfbRH9eipwBppalcnnwkW8Xjk8bOYVddV9wasb\nzoyItlkDWW2FI7TyO+W6JKm9WsGyOcWUXdYfaATVl67CuMZQEWWgwNhDDWGv\nfMLvPFf7IH9gEiHYR7EgO/I9BYUC4ge/WfZObw/Bnv0GWtp30fFqUdrFK++G\nrSC/0Sbpy5z/Xz6uUrTtI6cByvvZN80PyjEZL+JUtRL9dvsVuKi6wvWXRmZK\ngmgtSmSlNCHUhc/yTgUkCqCc7bjNtQsFu86jV1YJAqz7any3lbOxqgT4FCbm\nliaiKsaof9Xu3nos36pCo+Lxp/ZaqCB3YtBGdjBWfisNbyyqU/UOj/I2WCGd\nve+Q\r\n=V201\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIH8DXy8J8RDscVBEBULjNZvw31uK+D+ASQGNeHFXGTqzAiEAx+xfgOVzC/6TVdybOZXkfusV9XglGKKyT9HaTX1J7Ao="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_0.2.6-canary.0017be3_1568924179220_0.8997872163677834"},"_hasShrinkwrap":false},"0.2.6-canary.0f3b032":{"name":"bmp-ts","version":"0.2.6-canary.0f3b032","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![CircleCI](https://img.shields.io/circleci/project/github/hipstersmoothie/bmp-ts/master.svg?style=for-the-badge)](https://circleci.com/gh/hipstersmoothie/bmp-ts) [![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"0f3b032bfe1c123c98152a95dbce82b08bdf945c","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@0.2.6-canary.0f3b032","_nodeVersion":"12.10.0","_npmVersion":"6.10.3","dist":{"integrity":"sha512-b8131PHYnalYZBYeDmalgY2ykoh7xB20LN/cya8rRV+qTMSc6Z3rEFVpYGRZ/JDDlf20eICbcgQALkU00j7wGA==","shasum":"2dde34213e4a255c9a51f5d874fcbf22db2df6ed","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-0.2.6-canary.0f3b032.tgz","fileCount":18,"unpackedSize":64814,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdg+IiCRA9TVsSAnZWagAAahIP/iSRl/GjdvDp2eXe//st\nZGqa/i8OYxNhjp+c5ztWnGlvlxdyx1Xk+cqHsNY/HawzrlpzO0ewLMHK41zp\nUmXke8bZwOGdUjdcRWfqJv/mmCvjcwFA+02moBpDofe4HG5gt9bNFnMEr+ce\nvf0ptVZEWqDEPtK26b0ivxdCDriQ23U7TTU6KAagy1L9wnJmQtXjB85R05mW\n7mKbxg/JlAtLXgBvz0psfI21quYhBS1nu3burtmlgXTMx780i7vcL3NwQaQH\nZiAlwJ+Dmm4p/omTmnW3dCRAkXMYkeHhBddnUnvCgESP/8ukkLXkwUutsZ10\nIcyiJCHrnu+Y3qfw8X3Wt9Gfe32n0jUZGm42SM0T2I6wYtWONbvebkuj3ivL\nyOv9Ag36mNz82qQkNytm14Y0CfH/zFP+y1egKySKUDhQ+kQIMWBvXO8ibjgZ\nNG1ccCrQJ5DuWq3P4WYki4MvjJdygfCPBkfZ3D0nrG9tTP+K/dMh/47itGtn\nUwngdadk3AIVWRGLbv8pDFUdkSP1EWA66XxXJYt7E+42cCSxfDlQiU33wVNC\ncz6gsbGnNKGia9L8EMQof99hlP9jaBc4oo7ty+9qmT6umvQXLmwvAfB5zksS\nJfvW6xWj6i1ZS1+0j4pi3v/jNSYVQZ6zPpGBRcU37qw0Vqrs+Wf433jIUC4v\nQ0zS\r\n=57ep\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDkxmbZFNE719Bkyrx/WMLRK3s8nMajpp0hCjoCCN/W9gIhALoDLNnCez4Y49wMQl0Zt0gIM+gNvqd/ClOmhN8/KXTR"}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_0.2.6-canary.0f3b032_1568924193551_0.627952264491886"},"_hasShrinkwrap":false},"0.2.6-canary.c35951d":{"name":"bmp-ts","version":"0.2.6-canary.c35951d","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![CircleCI](https://img.shields.io/circleci/project/github/hipstersmoothie/bmp-ts/master.svg?style=for-the-badge)](https://circleci.com/gh/hipstersmoothie/bmp-ts) [![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"c35951d13d959299020589351cd49c681c04c98c","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@0.2.6-canary.c35951d","_nodeVersion":"12.10.0","_npmVersion":"6.10.3","dist":{"integrity":"sha512-h72dl1sdPU4ZoUggjKlduB1G+AwwRtTD+fLLeIaPmDGpNl75Xh4MbnLABJK1jEIjWvbj/UD90JPxzMR9DhwflA==","shasum":"13dcfda5ba20c39ef86cda51f74a7b222f512dcd","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-0.2.6-canary.c35951d.tgz","fileCount":18,"unpackedSize":64814,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdg+JiCRA9TVsSAnZWagAAwxYP/1fAcvW1tp3UgOEYdRNs\nRaxjH/W5LLkaHbpcirXlFD6AKENIIMcITqJ/PPm27RtVW5mzeX2nxO16EBV1\n6MJpL8s5SvkSG+bKJMlFgLs4t4v84fLejAn6jgUXpjQeIB7suWX2pvMTjFWg\njGemqmkp5ZITZmiayDRtfDc86CVvr472krGq/w8KAsOW/irpLoKajYXtlSK6\nXjM6IaSfIa4LEBwnk4Rrn85CYNDhfS+8kFEvGeEaNHbM4CSHYqT4FgI+S4ON\nJPzxHccy9IjQ7XcK5BORn/uOKaExwHsHXM5CXhtE9HrSPr8/+NDjvH7aoen1\nPNYsP0GoLJWX02X37GenpHGsIAn3WkwPodGm91IF90gB7VLhd0khrjYmWpds\nFNNbj4TgSpkNDVbLQj9RCzFWzYJAEreWHEiHJbAsyZzdDM6OTE5utch0s5Bm\nQBGyNc67Jvv4cyBGyrUcy9CHXhpdfYnhP3OGNLHP7OCWNEWgb7iFVreeP3QW\n1lv1qgJ6iMlpzQWqwWOijZPCUoN2Vl2jPv9ZX8sStcS/VojfOB32TQ5AI4PL\naK1PgZUcs9uzqoToyrNNJP3zkg/k3ACeV6QNHUGciJBOae6wc/0q0AYLjBkP\nQQqP/MGs5uZIAEzJFfOh77v11oHHN3cJkGK5eM4gvEeaXalS12/XZcA2SgGu\nIeue\r\n=F7Na\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBPSIj+cO3dumvIZ22IbfemTLQQvKXzyyhiEAfAHAImGAiEA679gahh8ZAvLIIohVHwzGfwoMLlqDN1vi0SI8SJR6ZQ="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_0.2.6-canary.c35951d_1568924258397_0.5156362583581997"},"_hasShrinkwrap":false},"0.2.6":{"name":"bmp-ts","version":"0.2.6","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"gitHead":"15135d3ea0186a71107f1b53978f08e1cc3e7b66","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@0.2.6","_nodeVersion":"12.10.0","_npmVersion":"6.10.3","dist":{"integrity":"sha512-6BLAgO2QgMLOl0DOJYJGYr5RLhv1I22uxhY3BEc3wWgpF+ZGKTmvDqfSqgYoui76YLeaiWBZQVB9QBFWOK6zZg==","shasum":"884314ada8908a1bc31caf676900c16161df3b7a","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-0.2.6.tgz","fileCount":19,"unpackedSize":69590,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdg+NOCRA9TVsSAnZWagAAnbIP/R8e3mHzpdxJgGOgmJMi\nJ6Pao9s6ouRVjFvoeCeLvCo2rx4pj76GLNB3KRPAuZsIbho2FVrJzplOBwf0\nFzYgUBtYT7HXOrEPFUkITs3/XC9785H+l/ynjxKIfojgC4IO/ZYr6E9zNw2r\nI+z4etP8DEBPBfKme5uXnQqaTIKLL6aypZqmuSObQ/uOm0le5ZVmShJyEoBY\n5bwCTDwM+zdro2VUDMrYocWKp8X7ePXsEzZC9APvZfaIMo6nHZX1ho67zhhR\nyKX6MMVyW+jLbyVNGvymOBDy5ZNu/r0ea/r1vV0Zsm5K20lzJSVJxVbSVYB7\ntpVj8xv6jHanvSvf8FyYokjC3Ah990M1bcmHjU31gQz5hIfQBqVyQqQ0pZ4c\nCfXQNGfo1wqJUNNxLTUsW8RzFqwx4HuhuQpZ15MMjN983IHG8G7nVIi/5UD0\nbCDwSQfUJyzCh88csjxFlbOGdM/NrmtEOe9hm5CdwZhCUWx9KsYsomqPiMUz\nfk3uaZcswbHPW8fmKtvxdu1lZiVhknX9oel8W0kHyer0p6iFuhoVR0rKoSgK\nkX3QoFPXVreNjKXoPaykY49SYVGU3CojSXLkHq0OsRhFcpuUG3LSTI9wuSDJ\nLAAsSHrsFWgGK0WhcjrTf/6imulQ+JX2MsXV9XQ8wNXlPTynhFtdmzMlfrqF\nOP+Z\r\n=7aVz\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGV9/FDxjKnR94HFd3/T7+eMdhSBtCFqE84bfpnxlsGkAiEA4GnrKfM2nTpPJcoBGD901gQzCliXD2dDWyufXaplqEA="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_0.2.6_1568924493842_0.5918584602605326"},"_hasShrinkwrap":false},"0.2.7":{"name":"bmp-ts","version":"0.2.7","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"gitHead":"7003612d791d4e36c55fe1f90bd56484d4b3bff1","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@0.2.7","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-FobC49f5bZgQa3CVDD0Su8KA/zqDMLTHkQNv33x5nGYWoDvrTWhjRafPWMFp7thesugYXIRlBnxOOrGY+7yf6g==","shasum":"8c6556c3f1c39453ea2ef557fa58d29c6bd420be","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-0.2.7.tgz","fileCount":19,"unpackedSize":69818,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdg+W/CRA9TVsSAnZWagAA3e4QAJEOxHAR4qMu7hm6unE4\n4xDuD5w4WZ5macPTXZXr4D0CMsQCDwsCseh/1+SDI143q3hW+CbCWBYyhjgX\nCo0IQwiDTOeTe4ERInJ9++pAvsq3OB+PbACYnU6MG39hSRPXuLmYaxGjSVZg\nxn3TNRj6kjc/BWK2SAn4qpMEeeoWxqUVF8Hq9o50PEcbCtiDI7KhZWNhPRnF\nn2XyG3b9y6gc76iwOW2VbR2wkzBhaU7m5QMsgdXIiJ+FuBKH9iKHZNXy/Ktu\nIAIq+WciIsV3yijy34cWQUDWJGkj+BEQTf1dMJiJ1bX9B34ksWFfCzVINBfu\nJvjzktVzVTOrdiKLEexBdfzoV12gXsxoROgHYTHSR+HvpufsE2zT8oe9RfZU\nkrdiYKShPicblWZ+wEGLlGi6+UcCGN4nV5G6hYkgEdI5lxY5pMIScwljvCoi\n9eQxISMcA9L7/F5Z4oE2MSUsuixMdrTsd6kMnRCI7tLtZsONfnNDUM5r+VyA\nMbqg985MIineGMdhaY22uFcB54x3l+OO872BL/X/JPIWTRKyFT2X8LQLD93v\nZ62KiWteaNNG+WrSkOhM4sw94KhUyg7Tfu3n1bvvOGchBvtotfUVKM1/4/Yd\n0zuY/+U5w1oFeE+myFmZiaqNFEPiKcWuFuAYf16K8P2mHxxAcELvjkTl6OBq\naEYH\r\n=UaS9\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAR1We9R5n7a6nQGfI0aml94BvsVfkG1xxtpHs98NAP9AiA7CUOrsK1a6h6L5JQyytZ95FMVAbk+8j8TnaNXZ2iPIg=="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_0.2.7_1568925119007_0.11020997880080108"},"_hasShrinkwrap":false},"0.2.8":{"name":"bmp-ts","version":"0.2.8","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"gitHead":"ce70d088ead3d254f74db6268b970ae2838be4b3","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@0.2.8","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-BYlk2ZdxeddPidqZQTw4SuHCeQL/HdHfCHjlKoFPoRR+zsjDjtFE9k+lAHNIPGjCNe0HKMGYW3NuKf1q9WO21A==","shasum":"53788f761035714fb7c6a84a0f58ea4c42eddf23","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-0.2.8.tgz","fileCount":19,"unpackedSize":70055,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdg+fQCRA9TVsSAnZWagAAYVgP/jTo/NLG5a2Da3T512pb\nYoOTpqA4h1hIlZOBqqDEIMfRAiKKBtiThfrQniVAYVQ/eOiVa0o9PeusybED\ntcExQ6MEdx7JQdtM8h1H4P8RNJ5kj7XT9jNgiDr6bJlO6QFH7Bz5y1nCftgT\nQbuRmx6w9G2IJa8MeHxqMuOgK9UC7kRnlOH2KQaKBpgbJNkj4vQ/6g/8i2QJ\ntjnMAauzuQGFD6aIPZhnA3h5qVlAfMCVcrWRwgsgXdNy5usCLs9Srp/C3k1m\nX3mC5BN1t8BNV+DprvA9B9rWqctHRbG/8MV7pHnV7LNnliJYXJ0ZiFzskdjP\nHY2MhKxeS1zHV+k3GRp9ANwIhGoV7kNHTD1DdbSAatxSPqJ+vDu3+XnDcdWp\neMcXYUFNw6xkbCj+IBAX5q44YmP/6a+a8n1m1f+9HwO/ltcVps2hRDvySD3R\nna6+HQIBbQ3rX8iXSBtwi2M2VwYOsWKkCbNH/2D31IDZOp6vbAYsoFt3C04v\nD9wHH2MoilY4raoxUNnXlCpicVPMcfO0dEFp50IxuK9ESCoAFFUIPla7PvRN\noTGBu6vcJ9M8++wawUk8CrfX5vWQYCQiB1AIOuOzW4QoiPBgIyVyM3jl5c05\n3wo9E8ONMs2eIuXUjz+Nr7MbI94lYrL/fZSHSbwN030o+pIIPiLvUsuiJPfN\nkf3N\r\n=ZcVl\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIH7zN/d4VCGWi6x9/PDoazAcSzkTejIsUbYpBbL+xZ9WAiEA9WrQS/0o6CL2oTsOodqElX+Isi4dNhYgZ36YoFliKuM="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_0.2.8_1568925648137_0.02808992951622935"},"_hasShrinkwrap":false},"1.0.0-canary.6547431":{"name":"bmp-ts","version":"1.0.0-canary.6547431","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"65474310328c3fa4b93cde812d50a58bf5181a72","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.0-canary.6547431","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-wJrsjWZbi/73iiYqB6l+u1v+cbVkj0RNoGrRGqeigT0qjwXOOv8r3KtjFFujoUGT49z23zYykXD1McJgKyqIBg==","shasum":"549dc4be49c275ae20387e83ceaf08652dc15560","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.0-canary.6547431.tgz","fileCount":19,"unpackedSize":69669,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdg+l/CRA9TVsSAnZWagAAcOEP/0oRKkyRf7TBFi3qQDSd\n/tqNGCxqq9m/U0TGnaLr35eRYfTZHkFQqzwRYw9AsfCrxSUHnGA6ZWmYMiAZ\ntyBPAL8KQSJg5Jbia+JmlZ23F3hevEZuFFZsN+mThdykcqGL1kdFPNCPZETo\npQuPwxn8uX763OPOp65dMmOJ5+rMMMirXxYQnmO59Gx0nnU+x9Rpl+OAN7MH\nW7C/5mNajPtTUG1B9ug6ReB5z/TJMAADeIY9jvfg7Z0CQXTQJmJmy5B9mZNc\nWmPeN5ZcetcrFxP9gI4+5KQBaYjs5mHHJvggLE5oYHwXN6HLN+/041hB41xq\nfuqPf/jUAz6oMuGtO+IQmR1hdF32QRePdXQLLazcrPvhfdyjq8lj+QKAeu3q\nrSINj2wBJvjo9POFxrFgWXOZ5tftPq4yzrJccnbujdVIETaVrhWuTHfVw7q5\nopJItomXIhjeXEq4jg4ZKeaI7mN3bg8WKha2uyxqoiIrKIx4GdMCvWErzddk\nAvAwRzcBiwcknu7EvEsPSdS3rBHMj8+tKk+jK8XcFTuVtiAb7APZ4cPTu0+r\nJczcfAEN9I5P/GfJlq3015a6/HvLeG91FwnRouelLhAzxpHIMQPq7AQyGELG\njsvmztMHviTk1c7SimNi+phV+9qvUtOsUzpAE1Kh57SF8fAC6Pfa2rupbCuM\nlLpJ\r\n=31Ck\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGRQwpsgcPGiIZZBiFlEfZqG84krWiEgD/PMO+QhvEhbAiAeE5hS6x/Tr+8iH85m6p4vNsP+nZrfz340ivthPDZqvA=="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.0-canary.6547431_1568926078897_0.5472760890068671"},"_hasShrinkwrap":false},"1.0.0":{"name":"bmp-ts","version":"1.0.0","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"gitHead":"6fe267a3d16fcdc97b97522ceae82f2258d6d359","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.0","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-PRIz5v730Ph6xdTrhQiTSA14ucwA0czuO6BexAkp1V0wW0YUcR/3Ji49fwI+uddpID9VFcUMpoIfVj9Z2z0vew==","shasum":"51333667d73d0322e17315b30b8e1b93cbab4de6","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.0.tgz","fileCount":19,"unpackedSize":70181,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdg+ujCRA9TVsSAnZWagAA3UQP/iAsRtPmX8dcZkO+pMUo\nim3XahYMNKG5DEdXaOLBKV5oWlsfP+Wv2gYlDiaM0V3qGXJRjeHou4U5fmBf\nIDWepkSBD31OhYjknVWY8ywjKZNuDBBJpPH4A/vgEva4sPuY+9eU1PUNGrL0\nDR8bnCy4zFI77Pg+C/gEqz3ouB/YFVyoJAsc4zhP1waALUcx5n3l7JAwoNsh\nsYzErW1Bp+DUfTGhwGNcz4lmCFd+Mljmv5CBmsq3ENhIY9AFMifOvB2bvUny\n/53+Jum++StXVVEfcsTnQI6Y8cIekpR/JgxPPQbBTxek3q7T3PndohEbysDW\nUDs6jK3o43LPM8GLu4ve0k6+u9R8IfSplgq1hVaPcKvV/eHnAo66UqXn62he\nl8Iq99ACHVLAb0Obhm4vWYm8wUL4f//BwxbIZb16JRq2wwLYze7hUAEewylf\n9vUsTrwpFs/L1XMIY/tearZRRj6dGTWEjbd+2D7XvJeXQEzDI4jSzU9C1rlg\n4Zf8S8PHiLh5W2rmC6HJ8IZL5xHj8B+9E1kkZTO91F2pVbm2YEnmJgJ2j14b\n4N9W6tQVWyDpkkmbKwzWpXib3Ua+/EkTRv7yRbxi1dcA7W+FY4YoyuuL7l/J\nFF0u22rDmFKBtb6xczxD/N4zM+bhabTVzkYBrshNI68WW3VhlJpP1pSO7Vuw\neAmB\r\n=jfme\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCj9ScjBG33yzVvescH7fqlAmmxz6+dEkxUSfYRFv++gAIgRnFTV/gg5ogM0W0BHv43Ng5WBXbnB0ijEQm09SQt57I="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.0_1568926626493_0.49499613410318943"},"_hasShrinkwrap":false},"1.0.1-canary.00a50fd":{"name":"bmp-ts","version":"1.0.1-canary.00a50fd","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"00a50fd562505c4fcb993bd500ab717be93651e2","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.1-canary.00a50fd","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-5OptulSxUVMziEE2JopgblOk1P9kL14YexPcmKdICxdU1yDJm/BpFQ1sMi4B137GnN+9DOP3dQZbt3d7ycaB/Q==","shasum":"e8110688bf58ceef706f07fed5ac1acd25579ec5","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.1-canary.00a50fd.tgz","fileCount":19,"unpackedSize":70196,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdkjppCRA9TVsSAnZWagAAsJkP/36gAhZXMGOJFepiQ1co\n3h35Y7m4MK6CCbDxV5wlX3UQJcrVLLot0R6dZWFoHLlXY0ZwopzzCfUgVngF\nv94wLifQiwFM+0B410NL1hGAE7eDvQlvhJOQvD5Kx3wJhm+x9nAGUudfvgK5\nS0Hep8e9aEHDgd1l35iMxzVOzD3RieXsYEoQEijoE2OLmsuOCRBJe152RZpr\nWwqG8ioL43XXdx1TPeBdu39IOpMdGflJfA6Ji6T7TpHaba0Bc4V/igT3Fz4s\n2KaSkt7qXJz9ZHzauh9X60T4CyR5kTfrsR794G4i9vAfoaf37pgWPQqoIfaL\nZeons9xpJ4hUt7r9670BHAbL1xpVZ/skL1MgA1SunUS3UuNUCDdcwot35a42\nb4WBnTGoHNnCKpvm2HTiLFJtlPUrrWD1ZZwgW9B+S54w//2DvApGC9OGQNSG\nR5wm6ONHjtYH6kROpvCc53T44nqOznz6/R/QFR62k/ulZ/63ITojXqyVuysC\nTnTfg+hC0Frja4Pc6X36cPg+9Xzn82c4lwadqBNNElZlmi4WZyEo8ZtK4+Xd\n5BDzHCMb5P03J22Cfae3j3oN0lpbtmiBXo1cRWmCSPTuZ95+MW0qr7dhrDD2\nvozQUINHtxGVSob38Oxq3KMPA5TIwQlqgVU5HT5bkfY319hXKxv+U1qj1P8d\no1X5\r\n=ED5p\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCgZD7/Pf6RwTCKxtJK8gH9zfZ4h4A/zxZ2XMAb/vXVwgIgVmIw8++IOo3cGRbFQIR8QJlSZH4dLQ0qvnQcmIrE8QE="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.1-canary.00a50fd_1569864296805_0.8187331061323988"},"_hasShrinkwrap":false},"1.0.1-canary.e5995ce":{"name":"bmp-ts","version":"1.0.1-canary.e5995ce","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"e5995ce4297ee8b0596c8cbb3d53f68f060dd52e","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.1-canary.e5995ce","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-na/R7Wc68typMXHWJt0kTcmAz17VgVfjgLvWJ7QiMDTnNAbaqJU4Gc51SDzQKNKkM+aFq7T64KW/WGghjX8EQA==","shasum":"e5f48f3e1df59ee235ac73ca55f3fe82c48f9229","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.1-canary.e5995ce.tgz","fileCount":19,"unpackedSize":70196,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdkjpvCRA9TVsSAnZWagAAaegP/0YQQ7x9RPQhWm11zbIP\n1DAOqgoBmmpEVc8PpYk2UDjsA2BIFYJlscKe0B+8MeHYoEHsFxNDuq8TsGgu\nfDbnjNDUUCe79OC/3FT8prdrKJ1rCl4H88qYqnXAqS4bLxRf0ppVWOKCLhMg\n/dj5CjvbjOuWI5fxBCYK6QBiePhY1Yo1Dy33conVPh2Z9eLUhLkbJq51TU6d\n+9PW0IrNrVwaxlL3K04wc2n42H0YCuCkPKYtXOz3QAjAyGb20PwZksiYK3Yr\nG27OzMC+0L1Gp3e4YbtFK6ip7XoH6d/wWQdPDTxhB8/Fkt5RdHVikdHF66qv\np2WEcfsFuWPmjkFuZPoz+LoTBMM+3GuBQFamwZCv8oH1yJ1kbqV/lVqSgOAF\nVDiijgea7HIFJroSkzZGBaZVzzzj53ti4PdQ1yAiqUckcxx4t3RetxN/FiXa\n6C6iwMv+Fv1tvvMpAbMzpv4G2tGM3wdvLqrcOpIpkPoFwAsiZKKufKnyxbja\n4MMswYHynphsNV2NSXEhneLnEUzVm/ce/T2KACEc2hScTJXXDiFgxNqo8TAT\n1nnrWGeSW9GgjvMoj9YVsHN/G2Oyv8U2y8j1KNAbca7VMYNwNWOlpd6tBmW6\nXZWvBAYDrCeTXSk/KcD9iqnFVfNJQ7QbMlFmvh0rY7lDl9dkTrqiWlJQLYxG\nVPC0\r\n=IFEs\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEcB3zXXU2CruN/F6NnTwIiyCyTZGHwJFUC6R/+prilIAiBcIKhEf+xtw7UgEnR8eKzgHemqtzaP18Znb2Ha0hg5wA=="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.1-canary.e5995ce_1569864302732_0.24274260454543684"},"_hasShrinkwrap":false},"1.0.1-canary.ec95656":{"name":"bmp-ts","version":"1.0.1-canary.ec95656","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"ec9565614a37330b97910622c28b14d896c52709","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.1-canary.ec95656","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-JNqpeRORP+qure/bGrqYzpRCYxX0UkMFzyEyOPyKvGV51XVHaUdQkUAa/NMAx9xDjz4Sx5F0o2U3ils8JtnLcQ==","shasum":"88322c5a08fc057d33648a9c6197eb033a18797f","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.1-canary.ec95656.tgz","fileCount":19,"unpackedSize":70196,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdkjp5CRA9TVsSAnZWagAAMWEP/A1kNPzp4RUnZKYIExj7\n8XlnXlayxl3jg8HYw/XEm05oXgzIySGmz6GQC7o3XnPAAXy7/PmrAO4UI+RO\ntghHANi1SDTrknYAyoZ7wm8enhj5qdtHeurLAZcIX8GNQGVzxNeXzSvsO9Xt\ncksoe/CAvxu9cFHDo1Vm0alc4Iae1i/x4OArHG4P74MBLrw5K443vgpyB09T\nSgSXFoPF0GMUCuXkIkK5h8++iCIEa1yx9cSGLxRla0BhBSmhwbCkV4BMcgLm\ni74tySnoX6MaFCneyxejedqX1qHCys/nLClFnXzPffcFqdEAmG9yQUDkpxDy\nOeElhSDo3huK2WdMiIqTDl/sxNMuiqYT7wkUl8oSViWnsPqqMy7hAtuco7Ir\n6X9zbGTATicm/E9s62N28HO9KW5GbDYYEp24wvwEFjWgqdXzwcH5CN439r/3\nIwQuyefFp8yPNaxdyfJoVxbyrEUV2efcDYMJx5Y5UYPCGsotphyx5a9zafmv\nmwe/FDQ8gDKJMM8BrtGbsLTWf6a092pTP1LjGyuSFKrLbDxU0eAHZ54oUfHn\nrCBCOdIQInIWvQpFnt1qv91zjxiBPCNehtLXyQNur1Nqn88CSvIDY3l12lQN\ndk1ReEkkAwDX3TtD6SCecc23Yd1lOePIIvUk4WLlWysM20y1wSL/WsxBJFfI\ny+3s\r\n=Jb6V\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDfPHdM5ipgcRo1vYJwxrxkl+ogduN9yIkwpcECA2Q9hwIhAKxNZ+v+sO2D9YQDtsmVmVgwapuEBFlxumhtGseAKZCR"}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.1-canary.ec95656_1569864312741_0.08077424810933609"},"_hasShrinkwrap":false},"1.0.1-canary.fbd7a34":{"name":"bmp-ts","version":"1.0.1-canary.fbd7a34","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"fbd7a346d97e99da98a6ff01cba1e3945b9289d5","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.1-canary.fbd7a34","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-qrKBtjq1J8Z4jzEVxhtbjXMYezv+SBsKDaEi72KkxVaEoc9fAax9ql/5yChWn3XeEo4fgo+zLiKdudmoQ2hcLA==","shasum":"88aa01e1c953c9f59337d6dcf307d7fd6369e852","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.1-canary.fbd7a34.tgz","fileCount":19,"unpackedSize":70196,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdkjq6CRA9TVsSAnZWagAApzcP/1iJfv7W5qdRBL7HVK+x\npKVRJ6VGf4SeVI92XkR+dczVjRLeRoYmckQo/J1lbyMZr3f8fqBaMvjvlz6o\ns97WRPbBN4T6qu6PvFxHTKQkw6BRPSTlGB5RQJ9mtPOD8cuOvhou4e4f8ZtU\nD7h0sMl+Kgc43ThxPLCt4baCTZqgyj6tlogj39vIZfMYRb6pi+sPgzX7U0z2\nGqU6QeTWgYybl/6ZmKSeSQuWyv03ma7OHAxuQncCK3HTvf78zUmywT4jyXnE\nYlK3fGRIHTe8GWmv0RFYhrSd7SCyheC+a/FsE2N9ERehJz9iLjefrMlGBCaZ\nc99J1PlNZSW73xHJ/tkJdw0HTrTS6XmkmTwYJoBDXgLeGE2SZJ+V2joFAQMX\nmqL+EQu0md3W75cdh72c2XB718JSA0PvKwTG47MPlBtfby8Tb8Nxq8nuSw3s\nFG+xB2a+T24/piQUPEyC7W2nvySLT2C31/1OGUfa3esaNReB8MFEbGwCLv4e\nqY8/xxxJl4dWc/EGUixZmHHIMEXnTDaaG1XHkcEZcUSPNBAQZDkisTWo2uw2\nu697UjmJj8WPAtS1Oroq/yRXh0MRg/cpaLHvE2GLu3dRoCIks6FjMevtuJj3\nakz71gBDPIYCErpEy2mWbwbg7lqM41fk2J8LFBQMSLrO+jts62CG2pwWBqan\nFgDg\r\n=sP+E\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCJEYvp2/ArK0Ci055CyMtD6M55wl+1Lcf639cAJDIBcAIgOoolLqWuH8a8d1Qq6vj98MPEFk+JY+5QZBzaaYw9www="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.1-canary.fbd7a34_1569864378154_0.42107696380551674"},"_hasShrinkwrap":false},"1.0.1-canary.698cc0c":{"name":"bmp-ts","version":"1.0.1-canary.698cc0c","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"698cc0c15eacd01e21eeeceabc532a03451c52d4","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.1-canary.698cc0c","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-dtT87YzXfPSvt13u6pPb7NExdmxEoMiFYuXOcKw40NnaWxmnsTEXZVqjnqCVIdZN0uVUMTSRDRBRMzAo0YpI+A==","shasum":"f0fde7165be932bd6eb26bfc555abb53f24fe1e7","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.1-canary.698cc0c.tgz","fileCount":19,"unpackedSize":70196,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdkjrqCRA9TVsSAnZWagAAVY8P/jLRkPY/F09MR/X0sEDp\nOH5WRW7oG/AchCMR0KOeVn7xie2+wmgWy2O16qYYFCChqCNAnQgDLxzMhODF\nzq/PexNDS48TYeVxGM8+eh7DkkOV/14fhaZzlNHqEqLI4t4TxFSArkaB3+6y\npoatSKh4A3O/jc4cY0StnDOtasPhAI2zjM4yhEgd/Qnb9HNYkow5jAVlnJVL\nRo7GX8lurP4dDhw14EQ1QOoB/jF272A1ISc4i13zxBlkyxsGxwHr0snLnkO4\nWl7Sxlxjk6FmEZ1NwWjAzFpUqs8fPYP7Ld0/zNuzo+Qb6JjHEiDOKIlArDQg\n/YsqnmXX+2abqGu8CLKhGoJd1smXLexRfIjhsmiwM7D3W/B6KbflRJoO8JwQ\nrzXaD+BVpFhA3GJ1juD22YMii3FXSjUNdaMFbK+PChuA1NsZBQBMTs/Rc9+V\nFEjRbihbtOJPrkj7iBCl2C5N3q3dvClODVbPQgW7fyafJaHUdYltXLTccV9n\ng0+MNHSYoQrCG4Rv95AYSc+uo2nqHGuWbV6VsZU2Xv3IGKECQ9xXHZoq5RQd\nOnVW/HYrlqUBW6edyoTQN+Q/8Ii0aS0Brq+qvvanb8erQhNs05j1OdwBrY4I\nAd/OSn0Tjc4b2Ur0pv9e7+4ifIf8iGC84eAWsCkxM4n1p/21EsXq+utd6GLJ\n/Xwi\r\n=fgnw\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC0Kf3Qxj3Dx1hbKy/60DcynDp+GZqCedT6RUrBfV1oTAIhALVAovwma9JN31NK/2qwGphFPi3swLVauLbcklNv7R1f"}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.1-canary.698cc0c_1569864426080_0.20617318647345373"},"_hasShrinkwrap":false},"1.0.1":{"name":"bmp-ts","version":"1.0.1","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"gitHead":"52fabc50415188692551a44b581e6cfede8c0264","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.1","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-mPjUAg7xXoeInmnYQKuSZ7aLyNGdn/wzD5CdoFhDMtXEHTeAmwlKNTQfew7/HJSUz/x4gmRVX4b9rCWBvDyl0A==","shasum":"2a26af981d377a39aebb8cb98dd7ce063acd9cbc","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.1.tgz","fileCount":19,"unpackedSize":71055,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdkjvwCRA9TVsSAnZWagAAkOQP/AoH9UrbukhcfIB80+pF\n+Hr142u0esjeJ9pb8YBraQ4zjpNYtslGWyZO84PWUQjQYxnc6NAWrsUzty7J\nDN4mJGVjZbJB+xTPtnukelNBnnu+HBuUBM6T10MQHNy3cBlJg7/+i41fVZjH\nUkZfYRaby3PdgQrVE54x6qe0gROj/vaMzS60VI9hbylh+2bkKTzJh/WHVnnn\nIGMo6K44z4eHRA4Ov0cQEuB7xeZIuS28Z0Sc2silutiStb5vJUtG/QeXflLn\n1t1tdMBYNl6k1Oz1CqXt6qracWmiMOg09yyN39y6PsG2BuJZrF3LaHpZoEej\n4b7BpOxCHZx7jkhel3Qn4PsAAD+9NQmBu2F2U6/Vb/TBkTgQYQesE6qoO8+v\n6Mp5j4m8ztauPN+UHZ9BvPpiZmacbjl7xwGaRIFAfv6lVGXDR0NxD3wtKSLA\njBnlSGzPHKI5BC6tD6Rg8mVFX2cl0w80pRcLvbzebrPQTMk3dhPE9LrzpZ0o\n0wmVbVJhAL7ljWXgp/228+gowb9c9UTpRj4nBPCXBqtOmaVoJvcykvR6dkjd\njLka+nUHu+0DPjXw7lxwHVKzJO+O46PTW0BYDLe6Bz0CfolOa1Ufuq6h1mw6\nPOH1F4KHGqNtnuh6y18r6QyIN2KwFJ1jjSNNHYEqf4xc3rTmZk1eRKMGY/R+\nR+Wd\r\n=iFRO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDI2egMYg+vSiy5GCGMoA4Kk8lVDXDzh0bxbN+OJXsUhwIhAP0xSaZzTdSsxzBw127XegwTEuPSpufNcwV5cVvjLTAI"}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.1_1569864688406_0.7454780159710139"},"_hasShrinkwrap":false},"1.0.2":{"name":"bmp-ts","version":"1.0.2","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"gitHead":"90b10ced8298d8b61a5628bfc66d94ab56b213c4","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.2","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-W2eZLtom+9eC+16jCC5f0KmyqWZMguoQO6IVdSsm6LXEu7NlXAHUSqHXqgH90dHSSjCiFZMzl1zLBb9vym6e+w==","shasum":"177be67f1d0d2c016bc0d634fe2f0994ed3efaf8","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.2.tgz","fileCount":19,"unpackedSize":71055,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdkjxgCRA9TVsSAnZWagAA8pQP/i/BO4d7mtWzhv79JEhd\nOmjUhdIXyVyRSvD8i8xOf87tOy9s8STnlKwyN0bRxL7WJR+wdsa5pbYPqcMt\nNdDF1S+957u8Ev3IM/IcEF9lm6gmrseB7a4t7+A9l3u1KYsokS+bC8xCYSIW\nYH5pCFRneCUUP5zp3Rn0HMnqYI5qTjWiwUcuPxiGX+y7Lby4qaBqAVCsenCW\njXScuOapQmAp/ggIKyNwpu2L4gecakwL0nQgg+dGwGrMhhB2/4D7OzBWiqgV\nMEuCOwWocDAdLTWPi3Xb8YeDEw1udo/nn+LNpXqUEx+X2vUwtN38eRo7rA5S\nzYGaBCdcAgt25Ju+UZz/lpeRSCBe7U5EHJZZDtu2XbgFIp26dxco3ckslySG\nrJOZLsLd5ts9YxZ6Hd9BNAws358vZbvtnkhOQpcuM08anb0t9ZUh+AnliXsz\nj4pkowLuPpoKCESAZgRi7t3eQo3Tpzd6bu5nGed5xYjH0Ln0JCIA1ASgxV8g\nRwW4S5MP1bNu0lHqTgPkjEZSUPGVvYCaPGq1wJXnzLNdxxCH1T1LAahMyFsp\n3LAK7ODq+s+AS0fmtgo3hjsgVigIa0yryyTM9I4U2rzSUZqCTYjXafTosELk\nu7EN7KbSOuTzHnVmHK5SC4wXkE9tMEw0gLszpl8K/3+iUeNr1XyzBknYkFXZ\nhtAu\r\n=Opzi\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC1BRRsrgaTLfx/+J2bWqnnLvby2vGPTlgh9mAPNJfv0QIhAK+PCGgVBOpcFIWFU63gqpdDb6aw6Qh6Pw2O6Xc/106t"}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.2_1569864799392_0.24815854216457822"},"_hasShrinkwrap":false},"1.0.3-canary.4716b39":{"name":"bmp-ts","version":"1.0.3-canary.4716b39","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"4716b398b526e41e17c79ce2e2293f19573ee1f9","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.3-canary.4716b39","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-eW8QFXlXGuI0iQfSJ7aH/6YSkZWqQguefJFIoqVbZTdfV6tk/x58syl3vs006K2ClXtxmc7fSPfjDq3kssMQpw==","shasum":"cd120575012e242847c2c987da06632396178374","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.3-canary.4716b39.tgz","fileCount":20,"unpackedSize":71743,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdpkaNCRA9TVsSAnZWagAAzbQP/35VILIKRx9DIsH+DpDL\nPO8kGFuatj9HKEBlL0LFkwN6PpKROKoCl8YIinIeqyJB5FK/8jbT78ydNmeo\nmh+88sHyyp7o1/tBY0naT9S95aQIzWOugdDYmfL0LJvokDXX7cLSlQ2GRjyY\nUtWdEOwqHH52C0h/AQ4L+taxcSW89jcTNmOJPJwCwINqyc4HCB5Kzxnscmvf\nxv5f6ScoW7N8xkXnOPSY+DUcXqpKUOQK1HwoEFQfStYXM+FdxPEuKk1LqaVb\n/+GSakbu7bpelClIfv7d9b5+Zb36Wur0EnqXKMqRjn3BeEDreCDPeIS5oerO\n1l+7ABLdGOxHnNp6HEaGZPke531daRd0dFSaqN1YdpjWPkbwqNdo5/HlC1ie\nGOWdCDx88ZBMP/HFLD566KLYIyvCVrVRO810Pu/Nz/2vKAKwmjyxn39BZTtq\ns6/cXDfvQS1C+FZq+qWd8XzMeaLdhRPzllyoFyU+jJvfmYHqyVIaLgTxbhq9\nlqukSoksvor7v/gssivrUU6EpnCuwS9gtorLZKw+gxR3Lmuf+Hga9q3UGyTj\nPVwV6CmjvkDMlqR/27Z2kuPGIIBpX2dovnDARhXJccpoLlzJZrRv1lFVtTao\nCVRv52zzpHoP9oVK0ZcvJxW1tOVNbhEDH34dovv9nnUm1jMYMioBr6lHMd/f\nq8Mo\r\n=g7v/\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCLSC37xKQ4lU6ce8wCagmEj/4OALx4WqzPWBYG/JPv/gIhAMR+HesoEWClnA+fbJ5SHXTtzCJCx1odlfQQlurJcVsA"}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.3-canary.4716b39_1571178125190_0.11242479377601766"},"_hasShrinkwrap":false},"1.0.3":{"name":"bmp-ts","version":"1.0.3","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"gitHead":"8ea7477757fce6ac0afee82462f7a21a3f280775","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.3","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-IQJpXxXXgb5c20mIpRrpg4zFasBjpBz912plIgmXLUkjFLjUkmevyDi7vcSL31VfJPzMGO4KnSIdULxjJ/W9FQ==","shasum":"97b2eea7f844259e200e2507d27726cd7f8494be","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.3.tgz","fileCount":20,"unpackedSize":72007,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdpkdlCRA9TVsSAnZWagAAxkcP/3ylZhNplCBIXCncH50I\nfVkd7lwiQVI5AZB7EdbYNscY7GsfKotnr/R1qQOvXsaQvR2gq0YoOHNTcFRJ\ncwfMUpQsNDSbHZPpQJ4pIP60rvef9jyrheezk19vO+y9VbA7PUykucFtU8om\n6nieaBocv86J9BbqWDRz5oesAy79uHJzL4nxHilDOn3lKm/+YhrPH/t6PuWv\noN+7Q1k5lpaKlcD0jDWzyM6U5EaOPF9FQHnCNMWmjBskOxKQ9rTg7RJweJ6H\nhdH8D4GvgsOu21qZQjw99CFyWy+1SVVDpZgBm4R2O+Y6LkdVDXEaSVwyIXno\nHYF91v5WbO37lT8kvYbDROdTHnoYgRAb/cKhrj9wWlPMtKvzzvns4Sgx2m1L\nWPPgzMUejdqpDMGLV1h6qt8x5Nt7VDUyNvUzLGkNie4/gI5mY96gRe/5tGL0\n0tZ/XrIJCsQ0NMNzhWn02osP7QSi5qriixaKV5ssNMAU/6XA4M4OuFh5fFzQ\nnIAs+NGIzX7jaLXgwleYKpkVHnChtUMFfBNaazEMfYX5SUDmYLcPUv+ASjTN\nKBhMFYR83Honh2ORoHTlJQ8cumG4SfyShweyR61CgzG8vfhtGZ4owLovuOBF\nG0cYHR3lAAEeIbcr0Ijg4A1kfTF+UuBAka5+Wit5qtf1smioPWqZ2weJURya\nZZbA\r\n=zm1S\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCfFQdEt67LKT+/1Bsk/P3PzGqweDaDfPBiqfLIUHPtDAIhAK33mpfvXqSx+BVkK5yNh14UDEnuazE6VtVE6Q/SwBuA"}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.3_1571178340421_0.020112993845286198"},"_hasShrinkwrap":false},"1.0.4-canary.af834ad":{"name":"bmp-ts","version":"1.0.4-canary.af834ad","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"af834ad7842feb5bcd425225a8484d88d277b750","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.4-canary.af834ad","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-y/CzT86yYBTM79GO5HNzS3CzYZxzCcOPcAj/XwWQNhiT/AUOx0t5n45tkG1G8/F0SiKJpMGOKM5TNwXHSJ3wZg==","shasum":"e0c2c03134243362f99d49bae27a723eaed7f7dc","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.4-canary.af834ad.tgz","fileCount":20,"unpackedSize":72022,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeiV4wCRA9TVsSAnZWagAA0f4P/2KTseiq8fxBOEog6ePY\nF/d/zFhJgS/7ol6iX9lZLFXTutsFxL+yFGTw12+5bdid2lGmKqPIzVsgbDqN\nZ95vZUcIRxiy0m1kPa11y+07Pv7/cR5x8Fvf7BqdJlcoxY6ChVH3kmbXQ7C+\nOVpwP/qnxJsfk19qOWlnZ36U7zRNFyipbQ7M/Z/YRs9MtbSNz99hgi/DbLt0\nOVyUa4G7yISAAhKRbUghKo8Z1oZh8cKQr75Yf8aId9QYzCuJw6brMhrDFslG\nLvd4V1HR4mvMoXaQx0XQcXmIDsgX1KViMxcx7ftyjS1Hj9XRLQ0Qi0zGZq/I\nBqB4mQRm5NdQ3cNaH3eYKjfnmc4joUDygSdcod60vD7MBKgGs1duC8aZlmdP\nNZ8/nZPVWQ8GAxKuTnplU+lCloeAhfWpl2e+1zmuFQFN78NBDoxURxScxPe2\nWu4sLm5ba/XHi1d6jf0AbWTGYQHwNvwr2CHKQoX4koa8BRgX+SiWVBx4jdek\nkuToDYOSzX4bsUGU16StZDh5PhK3LNIxMoE5Nq06PSq4fpw8rjMa4jCKlQur\nUU8AQFVVecOg4V1BzBMKCD+gPyIdtlsVlrV+cVabM8NpeJyJNnEBMq2YQiC/\n/9de5jwX0PLNbcTj4TSprTXOiSD+UBfIssFA9ec33xEApo5TY1i6fSA8spJ0\nPcd/\r\n=FWjX\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEtrUVH6p4ykZ5PRfBB19uSrHgXN50nhTsrgHaKxQF5NAiEA16EjlOGgg5/ZXbKfBU4Kfns1E1UOyWUT5nY9GSbcCoI="}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.4-canary.af834ad_1586060847999_0.655707976354734"},"_hasShrinkwrap":false},"1.0.4-canary.c510de9":{"name":"bmp-ts","version":"1.0.4-canary.c510de9","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"c510de98c5998a71fa3614f68e64b3deb6d397fd","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.4-canary.c510de9","_nodeVersion":"10.22.0","_npmVersion":"6.14.6","dist":{"integrity":"sha512-L0wkpwc9Jm9Vxx2pHWSZ27qAj3xZes1DAnOJrBHyAZGxdfZLsgTJeZkJ1ltZLAiLWo8x4bNnb4cG6tHZIqzQ/A==","shasum":"1751f2c906e923edecb14554410d9ecf62a23f89","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.4-canary.c510de9.tgz","fileCount":20,"unpackedSize":72022,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfVfbDCRA9TVsSAnZWagAAyvsP/19ZDYcf1OcpreJ22WaU\nG5xQc/vkxpRqunhBUp+WLwxIqmvhUUPYzyrlCzqGsKE67CJtmc9CVmU/0V42\n2vzl60cMaqJOXnt0ZddMpWHL4oghS3lbDoWmOL6/vxl8xUpxCvHXWKxaDM1r\nim47ZNESSUTFHBrMeL8lsJZX4wYjixeFpF07WSBmoGTUKxYYqClgkT7M64x7\n03Dfzha/JdEaXpg6KS4TfUFWgNQap/0LagrDDQwEbm7ZU4G3aLaopvoFJBq/\nad0w+fUV4Yq5RzDTlpuCG5IEwweQl00Qdd+A20K7iY2EOzE00JkPRZEV47TK\n+P6B2PsO+41o7o9M5rjwwWn37LDEqLRJ1tKgkvMYNzrPEqld3yQBap78JbI+\nTW06qnYg84y4Fnh3oL2gJ8eQ7Tvc7WIZ+jbatptK7VRm9dMHK5014VqBwJ5l\noNb+9iuTsh/o5nBkcMkIz5XiSFLHBULgzGymesuiJGDgG7iQryubNvCoC278\nSLH/VI3BdyPzJ9pSOIxMkKSEgjb4SnpNqtbRKLT1TgyY919qrorGz5fWH2dK\nExLEA4kxDiyQKx80pUNrl/6ZIcsBvvTTiq6LjubSQnXtG7YGDg4B8N2d1Viw\nKpKhwbLnlRnSpfYDdErbe6lCZup4xROJJRP2zi/44ac5YURUGqUO/0VT7e8D\nyojQ\r\n=OfVe\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDuipcr0S4+VrLlQss1ggazGbFtZU3Mxr34Op//V2n6vwIhAMalCy6mXsxIyS+jyzgnvHZsmM++71DyTGhQBeLmBxBM"}]},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.4-canary.c510de9_1599469250623_0.8916271931522246"},"_hasShrinkwrap":false},"1.0.4-canary.f6048cc":{"name":"bmp-ts","version":"1.0.4-canary.f6048cc","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^7.6.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 }\n  ]\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md","gitHead":"f6048cc2deccd59ce2f79648d82a11be2d0dc65b","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.4-canary.f6048cc","_nodeVersion":"10.23.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-LUr4deYKdZJ3QgVN+/UiIRJ55IQYOMdt2GhWXX/4EUSKe9pF/UIsyVyYjsBFptSA7t9SUXjGEwOA4obwOKUNmw==","shasum":"03cebb417e71e6430f897a01bf59c13e5900b8e8","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.4-canary.f6048cc.tgz","fileCount":20,"unpackedSize":72022,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf0+AACRA9TVsSAnZWagAAjyMP/1NqGr1ktE4HeffCztyz\n6Y6A3T+fJKkL1K3XO4oJjo2Q/ipTWNqNKX/H+BDxPYC83RVMuT0Iihw2hgwc\nC7V+nEBDGNVESwSNGnMsfGtYR2tyoVZDySPV5+sPrOIc631WinLmNML3WvmT\n54MRzumkWOl3sEVMlSD42XoL3/a3EkslhqwZPnMws0YXXar+J2Mb2PP9C7Z/\nDORi2ENd/WHdDTOuVs9LBwASoSLUIDmjpClIrCxTVWgGp/W+pfTb/c9ZkJZw\nNk7HGnOO+8x8hblyqfHE77R93vSdnuTy1W2uvePjzrNR+TiD75aFGLE3i+ki\nmWoNvKCJTO4+UsMYECc1Uvucq1W4rPwNgWkSpLdiQN9JNbNuq6NBtx8Q4J64\n0YE0OOs92divQElvYcGC5R2DofedH78fSAtCxj0m2IuruWh96v7tjko8NlWa\nTOo+V81PPXpE8vK7rN/KZE85VMNBKkJwBhC+RmoWj3x992LETEAzmyrQz6Fw\nqd1zugCDD+of3fiuyn/d/orFy6iPkNaHs61Hcap7Jp1S+SpB9TTopUWguqfP\nFjSPOdx2lgKsBGO1N56h/ie2itFZkIYoLRPwzbuHG+AMOZpm5qsvBukSvGyC\nuKPh1VRHIrjHqt/yQ2JTfcfxGww3fGN3swDFfIDy2nPY5nVPRnHv5WTXkA6u\n/6Pq\r\n=yNM5\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEj4OH077cvkIYXrKTBNfUdtZ3qinCm0ZXqpV65EoRbzAiEAsd4S2t2n7kXP843RTQSjxHNaQJ48eoYzjxRX8lxrLec="}]},"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.4-canary.f6048cc_1607720959826_0.3400952351251352"},"_hasShrinkwrap":false},"1.0.4":{"name":"bmp-ts","version":"1.0.4","description":"A pure typescript BMP encoder and decoder","main":"dist/index.js","exports":"./dist/index.js","types":"dist/index.d.ts","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tsc","lint":"tslint -p . --format stylish","test":"jest","release":"auto shipit"},"dependencies":{"@types/node":"^10.11.7"},"devDependencies":{"@types/jest":"^23.3.5","auto":"^10.46.0","husky":"^1.1.2","jest":"^23.6.0","lint-staged":"^7.3.0","prettier":"^1.14.3","ts-jest":"^23.10.4","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-xo":"^0.9.0","typescript":"^3.1.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"jest":{"collectCoverage":true,"coverageDirectory":"./coverage","coverageReporters":["json","lcov","text","html"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testMatch":["**/*.test.+(ts|tsx|js)"],"globals":{"test-jest":{"tsConfig":"tsconfig.json"}},"moduleFileExtensions":["ts","js"],"collectCoverageFrom":["**/*.{ts,tsx}","!**/*.d.ts","!**/dist/**","!**/node_modules/**","!**/vendor/**"]},"gitHead":"21702c08e081b94e225f46a2a7c3f9ce1507f50f","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_id":"bmp-ts@1.0.4","_nodeVersion":"18.17.0","_npmVersion":"9.6.7","dist":{"integrity":"sha512-vxr9qZk4BlEbUKW5qK/ywV0Y6GT1J9RIYYfOOWW3yer1SZfZAaL7Qqs003woBtNGI86ZXEtGYDblJlK0kqymmQ==","shasum":"b0868c6f2b5c873328ec22b0e18acd0ce74340c8","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.4.tgz","fileCount":4,"unpackedSize":9368,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICHsbBJIaBUSAIzl6iPMBhZjIsFc5MEwJDHihU4AeTsoAiAbq122RkMTX/ute+fUvTdjU8Kqglw8lcDqHjn2phfxBQ=="}]},"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.4_1690396355149_0.2646186808539057"},"_hasShrinkwrap":false},"1.0.5":{"name":"bmp-ts","version":"1.0.5","description":"A pure typescript BMP encoder and decoder","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tshy","test":"vitest","release":"auto shipit"},"devDependencies":{"@types/node":"^10.11.7","auto":"^11.1.2","prettier":"^3.2.5","tshy":"^1.12.0","typescript":"^5.4.3","vitest":"^1.4.0"},"prettier":{"singleQuote":true},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"tshy":{"exclude":["**/__test__/**"],"exports":{"./package.json":"./package.json",".":"./src/index.ts"}},"exports":{"./package.json":"./package.json",".":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js"},"require":{"types":"./dist/commonjs/index.d.ts","default":"./dist/commonjs/index.js"}}},"main":"./dist/commonjs/index.js","types":"./dist/commonjs/index.d.ts","type":"module","_id":"bmp-ts@1.0.5","gitHead":"edd66cc4112fd23bc58f370ee78a7b301f7365b9","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_nodeVersion":"18.19.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-CeW/JfgPlWTvPy1kXGJBj3yXbvpoSPW60/u3R9D+5Q3gPMvmyJF7dU3g2oWPOU16GMuLOYdYHbmM2dBubF+vgQ==","shasum":"905f7a357e972c3d7b099c6838e6a91d64a557fa","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.5.tgz","fileCount":41,"unpackedSize":129518,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIB/v9CmSUBcjrXTAlulhU5PRzObhwGV4BpkcN3E8gIHVAiEApjGtfHO0g0LwC927rdWIdbl5Ym8UotF+fZTYEYGGd8s="}]},"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.5_1711222809205_0.9231534048865424"},"_hasShrinkwrap":false},"1.0.6":{"name":"bmp-ts","version":"1.0.6","description":"A pure typescript BMP encoder and decoder","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tshy","test":"vitest","release":"auto shipit"},"devDependencies":{"@types/node":"^10.11.7","auto":"^11.1.2","prettier":"^3.2.5","tshy":"^1.12.0","typescript":"^5.4.3","vitest":"^1.4.0"},"prettier":{"singleQuote":true},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"tshy":{"exclude":["**/__test__/**"],"exports":{"./package.json":"./package.json",".":"./src/index.ts"}},"exports":{"./package.json":"./package.json",".":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js"},"require":{"types":"./dist/commonjs/index.d.ts","default":"./dist/commonjs/index.js"}}},"main":"./dist/commonjs/index.js","types":"./dist/commonjs/index.d.ts","type":"module","_id":"bmp-ts@1.0.6","gitHead":"d62c2be42c81373515ae47986a426cf90a5cdc69","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_nodeVersion":"18.19.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-7rxKlSlMK7Dz0AcaVaDTD4YRYHwXEjK38EUuNKm0R5uguWRSGnZT54m1rjWERnrbN5nc/biygiD+bs1j6sssXw==","shasum":"4d5c7511923e6df897fcad9222fb3a342f480cb2","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.6.tgz","fileCount":41,"unpackedSize":130249,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDfoToHn417JCc6BF5VOKuUmJgbPBds7c0TJjamoLTRoAiAV9W5O2xDI/gYS7MXAG3xuYNQIOhbVLEGfywtJVP0LvQ=="}]},"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.6_1711223159918_0.5253232173030384"},"_hasShrinkwrap":false},"1.0.7":{"name":"bmp-ts","version":"1.0.7","description":"A pure typescript BMP encoder and decoder","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tshy","test":"vitest","release":"auto shipit"},"devDependencies":{"@types/node":"^10.11.7","auto":"^11.1.2","prettier":"^3.2.5","tshy":"^1.12.0","typescript":"^5.4.3","vitest":"^1.4.0"},"prettier":{"singleQuote":true},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"tshy":{"exclude":["**/__test__/**"],"exports":{"./package.json":"./package.json",".":"./src/index.ts"}},"exports":{"./package.json":"./package.json",".":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js"},"require":{"types":"./dist/commonjs/index.d.ts","default":"./dist/commonjs/index.js"}}},"main":"./dist/commonjs/index.js","types":"./dist/commonjs/index.d.ts","type":"module","_id":"bmp-ts@1.0.7","gitHead":"93e3e68f15730e89a87d3665c792f0d7d2ed32ed","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_nodeVersion":"18.19.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-g+HD2xRgz4XYE/q3qrDNw96+n/PCdfQs05HmEse0Sk9Z9QAqdoaPar+BhTtbd419aZh8duk6BWDpZm/amsNYgg==","shasum":"da433004f251c795698b2cdb07b4a0bbeee75ad2","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.7.tgz","fileCount":41,"unpackedSize":130293,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGC91WpniRsY9y1pdOFujQJQCPokj5SlLcwWbRMi1ZdaAiALjysJZamE2Gk2Gdug7CKus1lID084h+A6nKxHWveJKw=="}]},"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.7_1711223930769_0.7089507996484432"},"_hasShrinkwrap":false},"1.0.8":{"name":"bmp-ts","version":"1.0.8","description":"A pure typescript BMP encoder and decoder","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tshy","test":"vitest","release":"auto shipit"},"devDependencies":{"@types/node":"^10.11.7","auto":"^11.1.2","prettier":"^3.2.5","tshy":"^1.12.0","typescript":"^5.4.3","vitest":"^1.4.0"},"prettier":{"singleQuote":true},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"tshy":{"exclude":["**/__test__/**"],"exports":{"./package.json":"./package.json",".":"./src/index.ts"}},"exports":{"./package.json":"./package.json",".":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js"},"require":{"types":"./dist/commonjs/index.d.ts","default":"./dist/commonjs/index.js"}}},"main":"./dist/commonjs/index.js","types":"./dist/commonjs/index.d.ts","type":"module","_id":"bmp-ts@1.0.8","gitHead":"4134c6c9d16a1724f6e0585424171c163b9a6680","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_nodeVersion":"18.19.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-IT+4NZJeKzzIvro1nd/4Ekzgo7pJ1LF46OZoE+FyyOfW1pBlM1rbqRyYIsdbI01YNZInDF02T7p/OjPK598mFg==","shasum":"2ea3b26c32d0f80d07d45d59ea69ebbb8b4a5d0b","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.8.tgz","fileCount":41,"unpackedSize":137953,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIH+7ooQf2iwGhc6Kd9gW41y1Plllwb3UV2GuCKOBxYHzAiEA3gA+qp0DknPV+vWgCfJ9E+TU16eVHjiAknjVW3a6guE="}]},"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.8_1711225519444_0.8996664957963298"},"_hasShrinkwrap":false},"1.0.9":{"name":"bmp-ts","version":"1.0.9","description":"A pure typescript BMP encoder and decoder","license":"MIT","repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"scripts":{"build":"tshy","test":"vitest","release":"auto shipit"},"devDependencies":{"@types/node":"^10.11.7","auto":"^11.1.2","prettier":"^3.2.5","tshy":"^1.12.0","typescript":"^5.4.3","vitest":"^1.4.0"},"prettier":{"singleQuote":true},"keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"tshy":{"exclude":["**/__test__/**"],"exports":{"./package.json":"./package.json",".":"./src/index.ts"}},"exports":{"./package.json":"./package.json",".":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js"},"require":{"types":"./dist/commonjs/index.d.ts","default":"./dist/commonjs/index.js"}}},"main":"./dist/commonjs/index.js","types":"./dist/commonjs/index.d.ts","type":"module","_id":"bmp-ts@1.0.9","gitHead":"2521cce93dbc770380940483af1a546bc42d0ed6","bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","_nodeVersion":"18.19.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-cTEHk2jLrPyi+12M3dhpEbnnPOsaZuq7C45ylbbQIiWgDFZq4UVYPEY5mlqjvsj/6gJv9qX5sa+ebDzLXT28Vw==","shasum":"0fd124ba812be9b786b29e5b186ee76d74ff5538","tarball":"https://registry.npmjs.org/bmp-ts/-/bmp-ts-1.0.9.tgz","fileCount":41,"unpackedSize":139275,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDi0pwYRYP19UrPJKEXxlLSqo1iIuxv5bxita7bovi2/AiBNkFZeaIMZSV4j8BB+VOGe7Sjq+YGmjzI0gBGf6Gu7Sg=="}]},"_npmUser":{"name":"alisowski","email":"lisowski54@gmail.com"},"directories":{},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bmp-ts_1.0.9_1711250769382_0.40637444700871694"},"_hasShrinkwrap":false}},"time":{"created":"2019-09-19T20:16:11.643Z","0.2.6-canary.36ca5a2":"2019-09-19T20:16:11.787Z","modified":"2024-03-24T03:26:09.979Z","0.2.6-canary.0017be3":"2019-09-19T20:16:19.311Z","0.2.6-canary.0f3b032":"2019-09-19T20:16:33.756Z","0.2.6-canary.c35951d":"2019-09-19T20:17:38.566Z","0.2.6":"2019-09-19T20:21:33.976Z","0.2.7":"2019-09-19T20:31:59.165Z","0.2.8":"2019-09-19T20:40:48.289Z","1.0.0-canary.6547431":"2019-09-19T20:47:59.066Z","1.0.0":"2019-09-19T20:57:06.615Z","1.0.1-canary.00a50fd":"2019-09-30T17:24:57.090Z","1.0.1-canary.e5995ce":"2019-09-30T17:25:02.891Z","1.0.1-canary.ec95656":"2019-09-30T17:25:12.884Z","1.0.1-canary.fbd7a34":"2019-09-30T17:26:18.334Z","1.0.1-canary.698cc0c":"2019-09-30T17:27:06.265Z","1.0.1":"2019-09-30T17:31:28.531Z","1.0.2":"2019-09-30T17:33:19.689Z","1.0.3-canary.4716b39":"2019-10-15T22:22:05.391Z","1.0.3":"2019-10-15T22:25:40.575Z","1.0.4-canary.af834ad":"2020-04-05T04:27:28.132Z","1.0.4-canary.c510de9":"2020-09-07T09:00:50.775Z","1.0.4-canary.f6048cc":"2020-12-11T21:09:19.966Z","1.0.4":"2023-07-26T18:32:35.313Z","1.0.5":"2024-03-23T19:40:09.401Z","1.0.6":"2024-03-23T19:46:00.064Z","1.0.7":"2024-03-23T19:58:50.905Z","1.0.8":"2024-03-23T20:25:19.637Z","1.0.9":"2024-03-24T03:26:09.559Z"},"maintainers":[{"name":"alisowski","email":"lisowski54@gmail.com"}],"description":"A pure typescript BMP encoder and decoder","homepage":"https://github.com/hipstersmoothie/bmp-ts#readme","keywords":["bmp","1bit","4bit","8bit","16bit","24bit","32bit","encoder","decoder","image","javascript","js"],"repository":{"type":"git","url":"git+https://github.com/hipstersmoothie/bmp-ts.git"},"author":{"name":"Andrew lisowski","email":"lisowski54@gmail.com"},"bugs":{"url":"https://github.com/hipstersmoothie/bmp-ts/issues"},"license":"MIT","readme":"<div align=\"center\">\n  <img width=\"200\" height=\"200\"\n    src=\"./logo.png\">\n  <h1>bmp-ts</h1>\n  <p>A pure typescript <code>bmp</code> encoder and decoder.</p>\n</div\n\n[![Codecov](https://img.shields.io/codecov/c/github/hipstersmoothie/bmp-ts.svg?style=for-the-badge)](https://codecov.io/gh/hipstersmoothie/bmp-ts)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\nSupports decoding and encoding in all bit depths (1, 4, 8, 16, 24, 32).\n\n## Install\n\n```sh\nnpm install bmp-ts\n```\n\n## Usage\n\n### Decoding\n\n`decode` will return an object that includes all the header properties of the `bmp` image file and the data. See header definition [below](#header).\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer);\n```\n\n#### Options\n\n- toRGBA - switch the output to big endian RGBA, making it compatible with other libraries like `pngjs`\n\n```js\nconst bmp = require('bmp-ts').default;\nconst bmpBuffer = fs.readFileSync('bit24.bmp');\nconst bmpData = bmp.decode(bmpBuffer, { toRGBA: true });\n```\n\n#### Supported Compression Methods\n\nCurrently compression is only supported during decoding. The following methods are implemented:\n\n- NONE - Most common\n- BI_RLE8 - Can be used only with 8-bit/pixel bitmap\n- BI_RLE4 - Can be used only with 4-bit/pixel bitmaps\n- BI_BIT_FIELDS - Huffman 1D - BITMAPV2INFOHEADER: RGB bit field masks, BITMAPV3INFOHEADER+: RGBA\n- BI_ALPHA_BIT_FIELDS - RGBA bit field masks - only Windows CE 5.0 with .NET 4.0 or later\n\n### Encoding\n\nTo encode an image all you need is a buffer with the image data, the height and the width. You can specify the bit depth of the output image by modifying `bitPP`. If you do not provide a value, the output image defaults to 24-bit.\n\nAll header fields are valid options to `encode` and will be encoded into the header.\n\n```js\nconst bmp = require('bmp-ts').default;\nconst fs = require('fs');\nconst bmpData = {\n  data, // Buffer\n  bitPP: 1 | 2 | 4 | 16 | 24 | 32, // The number of bits per pixel\n  width, // Number\n  height, // Number\n};\n\n// Compression is not supported\nconst rawData = bmp.encode(bmpData);\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n\n## Header\n\n| Property        | Type    | Purpose                                                                                                |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------ |\n| fileSize        | number  | The size of the BMP file in bytes                                                                      |\n| reserve1        | number  | Reserved; actual value depends on the application that creates the image                               |\n| reserve2        | number  | Reserved; actual value depends on the application that creates the image                               |\n| offset          | number  | The offset, i.e. starting address, of the byte where the bitmap image data (pixel array) can be found. |\n| headerSize      | number  | The size of this header (12 bytes)                                                                     |\n| width           | number  | The bitmap width in pixels (unsigned 16-bit)                                                           |\n| height          | number  | The bitmap height in pixels (unsigned 16-bit)                                                          |\n| planes          | number  | The number of color planes, must be 1                                                                  |\n| bitPP           | number  | The number of bits per pixel                                                                           |\n| compress        | number  | The compression method being used. See the supported compression methods                               |\n| rawSize         | number  | The image size. This is the size of the raw bitmap data; a dummy 0 can be given for BI_RGB bitmaps.    |\n| hr              | number  | The horizontal resolution of the image. (pixel per metre, signed integer)                              |\n| vr              | number  | The vertical resolution of the image. (pixel per metre, signed integer)                                |\n| colors          | number  | The number of colors in the color palette, or 0 to default to 2n                                       |\n| importantColors | number  | The number of important colors used, or 0 when every color is important; generally ignored             |\n| palette         | Color[] | The colors used to render the image. only used for 1, 4, and 8 bitPP images                            |\n| data            | Byte[]  | The data in ABGR                                                                                       |\n\n### Color\n\nThe color palette is returned when decoding a 1, 4, or 8 bit image.\n\nColor Format:\n\n```json\n{\n  \"red\": 255,\n  \"green\": 255,\n  \"blue\": 255,\n  \"quad\": 255\n}\n```\n\nTo encode to 4 or 8 bit a color palette must be provided. 1 bit defaults to black and white but you can override this via palette.\n\n```js\nconst rawData = bmp.encode({\n  data,\n  bitPP: 8,\n  width,\n  height,\n  palette: [\n    { red: 255, green: 255, blue: 255, quad: 0 },\n    { red: 255, green: 255, blue: 0, quad: 0 },\n    { red: 255, green: 0, blue: 255, quad: 0 },\n    { red: 255, green: 0, blue: 0, quad: 0 },\n    { red: 0, green: 255, blue: 255, quad: 0 },\n    { red: 0, green: 255, blue: 0, quad: 0 },\n    { red: 0, green: 0, blue: 255, quad: 0 },\n    { red: 0, green: 0, blue: 0, quad: 0 },\n  ],\n});\n\nfs.writeFileSync('./image.bmp', rawData.data);\n```\n","readmeFilename":"README.md"}