yetangitu/bitjs
1
0
Fork 0
mirror of https://github.com/codedread/bitjs synced 2025-10-03 17:49:16 +02:00
Code Issues Releases Wiki Activity

Add syntax highlighting to README file

Browse source
This commit is contained in:
codedread 2020-03-14 09:57:57 -07:00
parent 1bb77093ed
commit 1b70e58474
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -10,7 +10,7 @@ A set of tools to handle binary data in JS (using Typed Arrays).
This namespace includes stream objects for reading and writing binary data at the bit and byte level: BitStream, ByteStream. This namespace includes stream objects for reading and writing binary data at the bit and byte level: BitStream, ByteStream.
``` ```javascript
var bstream = new bitjs.io.BitStream(someArrayBuffer, true, offset, length); var bstream = new bitjs.io.BitStream(someArrayBuffer, true, offset, length);
var crc = bstream.readBits(12); // read in 12 bits as CRC, advancing the pointer var crc = bstream.readBits(12); // read in 12 bits as CRC, advancing the pointer
var flagbits = bstream.peekBits(6); // look ahead at next 6 bits, but do not advance the pointer var flagbits = bstream.peekBits(6); // look ahead at next 6 bits, but do not advance the pointer
@ -20,7 +20,7 @@ var flagbits = bstream.peekBits(6); // look ahead at next 6 bits, but do not adv
This namespace includes objects for unarchiving binary data in popular archive formats (zip, rar, tar) providing unzip, unrar and untar capabilities via JavaScript in the browser. The unarchiving actually happens inside a Web Worker. This namespace includes objects for unarchiving binary data in popular archive formats (zip, rar, tar) providing unzip, unrar and untar capabilities via JavaScript in the browser. The unarchiving actually happens inside a Web Worker.
``` ```javascript
var unzipper = new bitjs.archive.Unzipper(zipFileArrayBuffer); var unzipper = new bitjs.archive.Unzipper(zipFileArrayBuffer);
unzipper.addEventListener('progress', updateProgress); unzipper.addEventListener('progress', updateProgress);
unzipper.addEventListener('extract', receiveOneFile); unzipper.addEventListener('extract', receiveOneFile);
@ -45,7 +45,7 @@ function
The unarchivers also support streaming, if you are receiving the zipped file from a slow place (a Cloud API, for instance). For example: The unarchivers also support streaming, if you are receiving the zipped file from a slow place (a Cloud API, for instance). For example:
``` ```javascript
var unzipper = new bitjs.archive.Unzipper(anArrayBufferWithStartingBytes); var unzipper = new bitjs.archive.Unzipper(anArrayBufferWithStartingBytes);
unzipper.addEventListener('progress', updateProgress); unzipper.addEventListener('progress', updateProgress);
unzipper.addEventListener('extract', receiveOneFile); unzipper.addEventListener('extract', receiveOneFile);
@ -63,7 +63,7 @@ unzipper.update(anArrayBufferWithYetMoreBytes);
This namespace includes code for dealing with image formats. It includes a module for converting WebP images into alternative raster graphics formats (PNG/JPG). This namespace includes code for dealing with image formats. It includes a module for converting WebP images into alternative raster graphics formats (PNG/JPG).
``` ```javascript
import {convertWebPtoPNG, convertWebPtoJPG} from './bitjs/image/webp-shim/webp-shim.js'; import {convertWebPtoPNG, convertWebPtoJPG} from './bitjs/image/webp-shim/webp-shim.js';
// convertWebPtoPNG() takes in an ArrayBuffer containing the bytes of a WebP // convertWebPtoPNG() takes in an ArrayBuffer containing the bytes of a WebP