node-bcc
Version:
A simple Block Check Character library.
66 lines (44 loc) • 2.52 kB
Markdown
 [](https://conventionalcommits.org) [](https://github.com/beyerleinf/node-bcc/blob/master/LICENSE.md) [](https://www.npmjs.com/package/node-bcc) [](https://www.npmjs.com/package/node-bcc)  [](https://codecov.io/gh/beyerleinf/node-bcc) [](https://github.com/beyerleinf/node-bcc) [](<>) [](https://snyk.io/test/github/beyerleinf/node-bcc)
# node-bcc <!-- omit in toc -->
A simple Block Check Character Library.
This library provides its own TypeScript type definitions.
- [Features](#features)
- [Things to come](#things-to-come)
- [Installation](#installation)
- [Usage](#usage)
- [Helper Classes](#helper-classes)
- [Hex](#hex)
- [Ascii](#ascii)
## Features
- Calculate BCC for `string[]`, `number[]` and `Buffer`
- Helper function to convert ASCII strings to `number[]`
- Helper function to convett hex strings to `string[]`
## Things to come
- [ ] CLI application
- [ ] 0x-prepended strings
- [ ] Add more and better examples
## Installation
You can install `node-bcc` using `npm`.
```bash
npm install --save node-bcc
```
## Usage
For the full (generated) documentation go to [the Documentation](https://docs.beyerleinf.de/node-bcc)
```typescript
import { Bcc } from 'node-bcc';
console.log(Bcc.calculate(['A4', '37', 'F6', 'F8', 'CD']));
// 80
```
### Helper Classes
#### Hex
```typescript
import { Hex } from 'node-bcc';
console.log(Hex.split('AABBCC'));
// [AA,BB,CC]
```
#### Ascii
```typescript
import { Ascii } from 'node-bcc';
console.log(Ascii.asciiToByteArray('AABBCC'));
// [65, 66, 67]
```