Socket
Socket
Sign inDemoInstall

btparse

Package Overview
Dependencies
0
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    btparse

A modern bencode parser focused on speed and perfomance


Version published
Weekly downloads
35
increased by94.44%
Maintainers
1
Install size
50.0 kB
Created
Weekly downloads
 

Readme

Source

btparse Build Status npm license downloads

A modern bencode parser focused on speed and perfomance. It used recursive descent parser, a kind of top-down parsers.

Usage

// classic api
const decode = require('btparse')
// or you can use lazy parser
// const decode = require('btparse/lazy')

console.log(decode(torrent).info.name)

console.log(decode('d3:abcli13eee'))  // {abc: [ 13 ]}

Perfomance

nodejs 7.5.0 / windows 10 x64 / i5 4690

Libraryop/sms (1e5 op)
bencode118,387838.424
btparse161,059641.632
btparse#lazy143,2581090.971

API

decode(input: Buffer|String, opts: Options) -> Object|Number|Array|Buffer

Parse and decode bencoded message.

  • opts.depth: Number

Max parse depth for objects; default = infinity, min = 1

const decode = require('btparse')

console.log(decode('d2:abi2e2:bbd2:ccleee', {depth: 1}))  //  {ab: 2, bb: Buffer.from('d2:cclee')}

Lazy

decode(input: Buffer|String) -> Proxy<Object>|Number|Array|Buffer

The main difference is that all buffers aren't decoded into a string in parsing time. Required nodejs 6+.

const decode = require('btparse/lazy')


// get prop
console.log(decode(torrent).info.name)

// check prop
console.log('name' in decode(torrent).info)

// get all keys / props
console.log(Reflect.ownKeys(decode(torrent)))

License

MIT, (c) Dmitry Tsvettsikh, 2017+

Keywords

FAQs

Last updated on 19 Feb 2017

Did you know?

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

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc