Skip to content
JavaScript solution for encoding and decoding the Bencoding format
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
src
test
.gitignore
Makefile
README.markdown
bencode-min.js
bencode.js
license.txt
package.json

README.markdown

Bencode-js

Zero dependency JavaScript solution for implementing the encoding and decoding of the Bencode format. Works in both browser and commonjs environments.

Install

npm install bencode-js

For the browser, simply copy either the compressed or uncompressed file into your app and include it on your web page.

Usage

CommonJS environments:

Bencode = require('bencode-js')
Bencode.decode(...)
Bencode.encode(...)

In the browser the object is available globally as window.Bencode.

Bencode#encode(object)

object is either a String, Number, Array, or Object.

Bencode.encode("string")         // => "6:string"
Bencode.encode(123)              // => "i123e"
Bencode.encode(["str", 123])     // => "l3:stri123ee"
Bencode.encode({ key: "value" }) // => "d3:key5:valuee"

Bencode#decode(string)

string is a Bencoded string.

Bencode.decode("d3:key5:valuee") // => { key: "value" }
You can’t perform that action at this time.