Package Exports
- bencodec
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bencodec) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Bencodec
Library for decoding and encoding bencoded data.
Compliant with the BitTorrent bencoding specification.
Fast and easy to use.
Written in TypeScript.
Fully tested with 100% code coverage.
Without dependencies.
Installation
| npm | yarn |
|---|---|
npm install --save bencodec |
yarn add bencodec |
Getting Started
Import library
| typescript | javascript |
|---|---|
import bencodec from 'bencodec' |
const bencodec = require('bencodec') |
Decode data
By default, all strings will be parsed as buffers.
const data = bencodec.decode( 'd3:bar4:spam3:fooi42ee' );
// or
const data = bencodec.decode( Buffer.from('d3:bar4:spam3:fooi42ee') );
// data
{ bar: <Buffer 73 70 61 6d>, foo: 42 }To convert buffers to strings add stringify option.
const data = bencodec.decode( 'd3:bar4:spam3:fooi42ee', { stringify: true } );
// data
{ bar: 'spam', foo: 42 }
Encode data
By default method encode will return buffer.
const data = bencodec.encode({ bar: 'spam', foo: 42 });
// <Buffer 64 33 ... 65 65>
const data = bencodec.encode({ bar: 'spam', foo: 42 }, { stringify: true });
// 'd3:bar4:spam3:fooi42ee'Tests
npm testLicense
This project is licensed under the MIT License - see the LICENSE file for details.