npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

torrefy

v2.0.8

Published

An ESM package that uses Web Streams API to create v1, v2 or hybrid torrents in your web browser.

Downloads

28

Readme

Install

npm i torrefy # or yarn add torrefy

Basic usage

import { create, encode, decode } from "torrefy";

// create a test file
const testFile = new File(
  ["Hello world. This is the test file content."],
  "testfile.txt"
);

// calculate (hash) the meta info of the test file
const metaInfo = await create([testFile]);

// bencode meta info into a readable stream
const torrentStream = encode(metaInfo);

// tee the readable stream into two readable streams
const [torrentStream1, torrentStream2] = torrentStream.tee();

// consume the first readable stream as an array buffer
const torrentBinary = await new Response(torrentStream1).arrayBuffer();

// decode the second readable stream into meta info
const decodedMetaInfo = await decode(torrentStream2);

Features

Supports Creating V1, V2 or Hybrid Torrents

This package supports creating v1, v2 (introduction blog) or hybrid (introduction blog) torrents.

Covers Various Web File APIs

This package can handle input files or directories acquired from File API, File and Directory Entries API or File System Access API.

Supports Comprehensive Options

TBD

Supports Handling Progress

TBD

Exposes Stream-Based APIs

The create function consumes an iterable of input files as ReadableStreams with options and populates a MetaInfo object. This function internally uses several TransformStreams to chop the files into pieces and hash them.

The encode function consumes any bcodec friendly entity (e.g. MetaInfo object) and bencodes it into a ReadableStream.

The decode function consumes any bcodec friendly ReadableStream (e.g. torrent ReadableStream) and bdecodes it into the corresponding entity. This function internally uses a TransformStream called Tokenizer to tokenize the input ReadableStream and then calls parse function to parse the Tokens.

All TransformStreams used in this package are also exported.

Supports a Comprehensive Set of Bcodec Friendly Javascript Types

Bcodec friendly Javascript types includes (for the time being):

| Bcodec Type \ Javascript Type | Strict | Loose | | :---------------------------: | :---------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------: | | ByteString | string | string ArrayBuffer | | Integer | number bigint | number bigint boolean | | List | Strict[] | Loose[] | | Dictionary | {[key: string]: Strict} | {[key: string]: Loose} Map<string \| ArrayBuffer, Loose> | | ignored | - | undefined null |

encode function supports all Loose type inputs and decode function always returns Strict type results.

Supports Hooks in Bencoding

You can register encoder hooks when using the encode function. A common use case is extracting the bencoded info dictionary and calculating the infohash. (This package doesn't provide an out-of-box function to calculate infohash for now)

To use encoder hooks, you will have to install the peer dependency @sec-ant/trie-map, which acts as an encoder hook system and allows you to register encoder hooks with iterable paths as keys in. Refer to its README to learn more about the package.

This package provides several helper functions to help you register hooks in a hook system and consume their results as you please: useUint8ArrayStreamHook, useArrayBufferPromiseHook, useTextPromiseHook. You can also define your own functions to register and use hooks.

Here is probably how you should use this feature:

import { encode, EncoderHookSystem, useArrayBufferPromiseHook } from "torrefy";
import { TrieMap } from "@sec-ant/trie-map";

// create a dummy object to encode
const dummyObject = {
  a: "b",
  c: 1,
  info: {
    foo: "bar",
  },
  s: ["t"],
};

// initialize an encoder hook system
const hookSystem: EncoderHookSystem = new TrieMap();

// register an encoder hook under dummyObject.info path in the hook system
// and consume the result as an array buffer promise
const infoArrayBufferPromise = useArrayBufferPromiseHook(["info"], hookSystem);

// pass the hook system as an input argument to the encode function
const bencodedReadableStream = encode(dummyObject, hookSystem);

// consume the result of the hook
const infoArrayBuffer = await infoArrayBufferPromise; // => ArrayBuffer(12)