You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP
Socket
Book a DemoInstallSign in
Socket

bencodec

Package Overview
Dependencies
Maintainers
1
Versions
18
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

bencodec

Library for decoding and encoding bencode data

3.1.0
latest
Source
npmnpm
Version published
Weekly downloads
43
-49.41%
Maintainers
1
Weekly downloads
 
Created
Source

Bencodec

ci Coverage Status NPM Downloads NPM License Commitizen friendly

Library for decoding and encoding bencode 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 install --save bencodec

Getting Started

Decode data

By default, all strings will be parsed as buffers

import bencodec from 'bencodec';

const result = bencodec.decode( 'd3:bar4:spam3:fooi42ee' );
// result = { bar: <Buffer 73 70 61 6d>, foo: 42 }

To convert buffers to strings add stringify option

const result = bencodec.decode( 'd3:bar4:spam3:fooi42ee', { stringify: true } );
// result = { bar: 'spam', foo: 42 }

Encode data

By default method encode will return buffer

import bencodec from 'bencodec';

const result = bencodec.encode({ bar: 'spam', foo: 42 });  
// result = <Buffer 64 33 ... 65 65>

To convert buffer to string add stringify option

const result = bencodec.encode({ bar: 'spam', foo: 42 }, { stringify: true });
// result = 'd3:bar4:spam3:fooi42ee'

Tests

npm test

License

This project is licensed under the MIT License - see the LICENSE file for details

Keywords

bencode

FAQs

Package last updated on 13 Jun 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts