bencodejs
v1.0.0
Published
Library to encode and decode data in the Bencode format.
Downloads
8
Maintainers
Readme
Bencode-JS
Library to encode and decode data in the Bencode format.
Install
npm install bencodejs
Usage
Setup
const Bencode = require('bencodejs');
Encoding
const pingQuery = {"t":"aa", "y":"q", "q":"ping", "a":{"id":"abcdefghij0123456789"}}
const bencodedObj = Bencode.encode(pingQuery);
d1:ad2:id20:abcdefghij0123456789e1:q4:ping1:t2:aa1:y1:qe
Decoding
const exampleResponse = 'd1:rd2:id20:mnopqrstuvwxyz123456e1:t2:aa1:y1:re';
const obj = Bencode.decode(exampleResponse, 'ascii');
{ r: { id: 'mnopqrstuvwxyz123456' }, t: 'aa', y: 'r' }
Methods
encode ⇒ Buffer
Encodes data in the bencoded format.
| Param | Type | | --- | --- | | obj | Object | Number | String | Array | Buffer |
decode ⇒ Buffer | String | Number | Array | Object
Decodes data encoded in the bencoded format.
| Param | Type | | --- | --- | | buf | Buffer | | encoding | String |