Skip to content

A simple Block Check Character Library for Node.js

License

Notifications You must be signed in to change notification settings

beyerleinf/node-bcc

Repository files navigation

Maintenance Conventional Commits license npm npm GitHub Workflow Status Codecov Known Vulnerabilities

node-bcc

A simple Block Check Character Library. This library provides its own TypeScript type definitions.

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.

npm install --save node-bcc

Usage

For the full (generated) documentation go to the Documentation

import { Bcc } from 'node-bcc';

console.log(Bcc.calculate(['A4', '37', 'F6', 'F8', 'CD']));
// 80

Helper Classes

Hex

import { Hex } from 'node-bcc';

console.log(Hex.split('AABBCC'));
// [AA,BB,CC]

Ascii

import { Ascii } from 'node-bcc';

console.log(Ascii.asciiToByteArray('AABBCC'));
// [65, 66, 67]