bitray
Version:
Bitray - Small Utility For Handling Binary Data
73 lines (51 loc) • 1.47 kB
Markdown
# Bitray
**A Small Utility For Handling Binary Data**
## About
- Integrates With Buffer
- Small And Fast
- Works In Browser And Node
- Zero Dependencies
## Installation
```bash
~ npm install bitray --save
```
## Usage
**Basic Usage**
```js
const Bitray = require('bitray')
const bit = new Bitray('Hello World 🌎')
console.log(bit.toFormat('hex'))
```
**Buffer Integration**
Convert Bitray to Buffer
```js
const Bitray = require('bitray')
const bit = new Bitray('Hello World 🌎')
const buffer = Buffer.from(bit)
//===> <Buffer 68 65 6c 6c ... >
```
Convert Buffer to Bitray
```js
const Bitray = require('bitray')
const buff = Buffer.from('Hello World 🌎')
const bit = Bitray.from(buff)
//===> <Buffer 68 65 6c 6c ... >
```
## Encodings
Binray Supports The Following Encodings:
- **Utf-8**
- **Base64**
- **Hex**
- **Binary/Latin1**
- **Ucs2**
- **Utf16**
## API
### new Bitray(data: String | ArrayLike, format) -->> Uint8Array
Creates A New Bitray Instance. Built On Top Of Uint8Array.
### .toFormat(encoding: string) -->> String
Convert Bitray Into A String Encoding.
## Performance
**Encode Performance**
**Decode Performance**
