WebTorrent

https://github.com/webtorrent/webtorrent
Admin
WebTorrent is a streaming torrent client for Node.js and the browser that uses WebRTC for...
Tokens:93,483
Snippets:729
Trust Score:9.3
License:MIT
Update:3 days ago
Show doc for...
Tokens:
Raw
### Start listening with server.listen

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/server.md

Demonstrates how to start the server and log the port it is listening on.

```js
const server = client.createServer()
server.listen(0, () => {
  console.log('serving on port', server.address().port)
})
```

--------------------------------

### Install WebTorrent CLI

Source: https://github.com/webtorrent/webtorrent/blob/master/README.md

Install the WebTorrent command line interface globally.

```bash
npm install webtorrent-cli -g
```

--------------------------------

### Install WebTorrent library

Source: https://github.com/webtorrent/webtorrent/blob/master/README.md

Install the WebTorrent package for use in Node.js or browser environments.

```bash
npm install webtorrent
```

--------------------------------

### Install and run WebTorrent CLI

Source: https://github.com/webtorrent/webtorrent/blob/master/README.md

Install the command line interface globally and display help information.

```bash
$ npm install webtorrent-cli -g
$ webtorrent --help
```

--------------------------------

### Full Video.js integration example

Source: https://github.com/webtorrent/webtorrent/blob/master/docs/tutorials.md

A complete HTML example showing how to include Video.js dependencies and initialize WebTorrent streaming within a module script.

```html
<!DOCTYPE html>
<html>
  <head>
    <title>Web Torrent Tutorial</title>
    <meta charset="UTF-8" />
    <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/video.js/7.8.1/video-js.min.css" />
    <script src="//cdnjs.cloudflare.com/ajax/libs/video.js/7.8.1/video.min.js"></script>
  </head>
  <body>
    <video id="video-container" class="video-js" data-setup="{}" controls="true"></video>
    <script type='module'>   
      import WebTorrent from 'https://esm.sh/webtorrent/dist/webtorrent.min.js'
      const client = new WebTorrent()
      const torrentId = 'magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10&dn=Sintel&tr=udp%3A%2F%2Fexplodie.org%3A6969&tr=udp%3A%2F%2Ftracker.coppersurfer.tk%3A6969&tr=udp%3A%2F%2Ftracker.empire-js.us%3A1337&tr=udp%3A%2F%2Ftracker.leechers-paradise.org%3A6969&tr=udp%3A%2F%2Ftracker.opentrackr.org%3A1337&tr=wss%3A%2F%2Ftracker.btorrent.xyz&tr=wss%3A%2F%2Ftracker.fastcast.nz&tr=wss%3A%2F%2Ftracker.openwebtorrent.com&ws=https%3A%2F%2Fwebtorrent.io%2Ftorrents%2F&xs=https%3A%2F%2Fwebtorrent.io%2Ftorrents%2Fsintel.torrent'
      const player = document.querySelector('video')

      const controller = await navigator.serviceWorker.register('./sw.min.js', { scope: './' })
      await navigator.serviceWorker.ready
      client.createServer({ controller })

      client.add(torrentId, torrent => {
        // Torrents can contain many files. Let's use the .mp4 file
        const file = torrent.files.find(file => file.name.endsWith('.mp4'))

        // Stream to a <video> element by providing an the DOM element
        file.streamTo(player)
        console.log('Ready to play!')
      })
    </script>
  </body>
</html>
```

--------------------------------

### Install webtorrent-hybrid via npm

Source: https://github.com/webtorrent/webtorrent/blob/master/docs/faq.md

Use this command to install the webtorrent-hybrid package. Adding the -g flag installs the command line program globally.

```bash
npm install webtorrent-hybrid -g
```

--------------------------------

### client.get(torrentId) usage example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Example showing how to retrieve a torrent using a magnet URI and log its name if found.

```js
const torrent = await client.get('magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10')
if (torrent) console.log(torrent.name)
```

--------------------------------

### file.createReadStream(opts) usage example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/file.md

Example of creating a read stream for a specific byte range and listening for data chunks.

```js
const stream = file.createReadStream({ start: 0, end: 1024 })
stream.on('data', chunk => console.log(chunk.length))
```

--------------------------------

### torrent.select example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/torrent.md

Example of selecting pieces 0 through 10 with priority 1 and a notification callback.

```js
torrent.select(0, 10, 1, () => console.log('selection progressed'))
```

--------------------------------

### file.arrayBuffer(opts) usage example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/file.md

Example of retrieving the entire file as an ArrayBuffer and logging its byte length.

```js
const buf = await file.arrayBuffer()
console.log(buf.byteLength)
```

--------------------------------

### torrent.addWebSeed example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/torrent.md

Example of adding a web seed using a URL.

```js
torrent.addWebSeed('https://webtorrent.io/torrents/')
```

--------------------------------

### Node.js full lifecycle example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/server.md

Demonstrates creating a server, adding a torrent, and cleaning up resources in a Node.js environment.

```js
const client = new WebTorrent()
const server = client.createServer({ hostname: 'localhost' })
server.listen(0)

client.add(magnetURI, torrent => {
  const url = torrent.files[0].streamURL
  console.log(`http://localhost:${server.address().port}${url}`)
})

// cleanup
server.close()
client.destroy()
```

--------------------------------

### Prioritize a file for download

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/file.md

Example showing how to find a specific file by extension and set its download priority.

```js
const file = torrent.files.find(f => f.name.endsWith('.mp4'))
file.select(1) // prioritize this file
```

--------------------------------

### torrent.addPeer usage example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/torrent.md

Example of adding a peer manually after the infoHash event has been emitted.

```js
torrent.on('infoHash', () => {
  const added = torrent.addPeer('12.34.56.78:4444', 'manual')
  console.log('peer added:', added)
})
```

--------------------------------

### client.remove usage example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Example of removing a torrent and deleting the associated files on disk.

```js
await client.remove(torrentId, { destroyStore: true })
```

--------------------------------

### file.blob() usage

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/file.md

Example of creating a URL from a file blob.

```js
const blob = await file.blob()
const url = URL.createObjectURL(blob)
```

--------------------------------

### torrent.on('download', ...)

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/torrent.md

Example of using the 'download' event to report download progress and speed.

```APIDOC
## Event: 'download'

### Description
Emitted when data is downloaded. Use this event to report progress and speed.

### Payload
- `bytes` (number) - The number of bytes downloaded in this event.

### Example
```js
torrent.on('download', bytes => {
  console.log('downloaded', bytes, 'speed:', torrent.downloadSpeed, 'progress:', torrent.progress)
})
```
```

--------------------------------

### Create HTTP server in Node.js

Source: https://github.com/webtorrent/webtorrent/blob/master/docs/api.md

Example of creating an HTTP server for a torrent in a Node.js environment.

```js
const client = new WebTorrent()
const magnetURI = 'magnet: ...'

const instance = client.createServer()
instance.server.listen(0) // start the server listening to a port
// 0 automatically finds an open port instead of forcing a potentially used one
client.add(magnetURI, torrent => {
  // create HTTP server for this torrent

  const url = torrent.files[0].streamURL
  console.log(url)
  // visit http://localhost:<port>/webtorrent/ to see a list of torrents

  // access individual torrents at http://localhost:<port>/webtorrent/<infoHash> where infoHash is the hash of the torrent
})

// later, cleanup...
instance.close()
client.destroy()
```

--------------------------------

### Node.js fetch file with range

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/endpoints.md

Example of creating a server and fetching a file slice using the Range header in a Node.js environment.

```javascript
const server = client.createServer()
server.listen(0)
client.add(magnetURI, torrent => {
  const url = `http://localhost:${server.address().port}${torrent.files[0].streamURL}`
  // GET <url> with "Range: bytes=0-1023" → 206 with Content-Range
})
```

--------------------------------

### client.add error handling

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Example demonstrating how to listen for error and warning events on a newly added torrent instance.

```js
const torrent = client.add(torrentId)
torrent.on('error', err => console.error('torrent error:', err.message))
torrent.on('warning', err => console.warn('warning:', err.message))
```

--------------------------------

### WebConn httpRequest usage example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/webconn.md

Demonstrates how to manually trigger an HTTP request for a specific piece range.

```js
const conn = new WebConn('https://example.com/torrents/', torrent)
conn.httpRequest(3, 0, 16384, (err, data) => {
  if (err) return console.error('web seed request failed:', err.message)
  console.log('got', data.length, 'bytes')
})
```

--------------------------------

### Create HTTP server in Browser

Source: https://github.com/webtorrent/webtorrent/blob/master/docs/api.md

Example of creating an HTTP server for a torrent in a browser environment using a service worker.

```js
const client = new WebTorrent()
const magnetURI = 'magnet: ...'
const player = document.querySelector('video')

const controller = await navigator.serviceWorker.register('./sw.min.js', { scope: './' })
await navigator.serviceWorker.ready
client.createServer({ controller })

client.add(magnetURI, torrent => {
  const url = torrent.files[0].streamURL
  console.log(url)
  // visit <origin>/webtorrent/ to see a list of torrents, where origin is the worker registration scope.
  // access individual torrents at /webtorrent/<infoHash> where infoHash is the hash of the torrent
})

// later, cleanup...
client._server.close()
client.destroy()
```

--------------------------------

### Iterate over file chunks

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/file.md

Example showing how to use the async iterator to process file chunks as they are downloaded.

```js
for await (const chunk of file) {
  console.log('chunk of', chunk.length, 'bytes')
}
```

--------------------------------

### client.seed basic usage in browser

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Example of seeding files in a browser environment with a custom name.

```js
const torrent = client.seed(files, { name: 'my-files' }, torrent => {
  console.log('seeding:', torrent.infoHash, torrent.magnetURI)
})
```

--------------------------------

### Browser service worker example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/server.md

Demonstrates registering a service worker and streaming a torrent file to a video element in the browser.

```js
const controller = await navigator.serviceWorker.register('./sw.min.js', { scope: './' })
await navigator.serviceWorker.ready
client.createServer({ controller })

client.add(magnetURI, torrent => {
  torrent.files[0].streamTo(document.querySelector('video'))
})
```

--------------------------------

### torrent.select(start, end, priority, notify) implementation

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/torrent.md

Internal implementation of selecting a range of pieces for download.

```js
select (start, end, priority, notify) {
  this._select(start, end, priority, notify, false)
}
```

--------------------------------

### client.throttleDownload and throttleUpload usage

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Example of setting a download limit to 500 KB/s and disabling the upload throttle.

```js
client.throttleDownload(500_000) // 500 KB/s
client.throttleUpload(-1)        // disable upload throttle
```

--------------------------------

### peer.startConnectTimeout()

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/peer.md

Starts a connect timeout: 25 s for webrtc, 5 s for tcpOutgoing/utpOutgoing. On expiry, destroys the peer with Error('connect timeout').

```js
startConnectTimeout () { ... }
```

--------------------------------

### torrent.on('wire', ...)

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/torrent.md

Example of using the 'wire' event to add a custom protocol extension when a new peer wire connects.

```APIDOC
## Event: 'wire'

### Description
Emitted when a new peer wire connects. Use this event to add custom protocol extensions.

### Payload
- `wire` (object) - The wire object representing the connection.
- `addr` (string) - The address of the connected peer.

### Example
```js
torrent.on('wire', (wire, addr) => {
  console.log('connected to peer at', addr)
  wire.use(MyExtension)
})
```
```

--------------------------------

### Get file contents as ArrayBuffer

Source: https://github.com/webtorrent/webtorrent/blob/master/docs/api.md

Example of using file.arrayBuffer() to get the entire file contents as an ArrayBuffer. The output shows a sample ArrayBuffer with byteLength 4.

```javascript
const data = await file.arrayBuffer()
console.log(data) // ArrayBuffer { [Uint8Contents]: <00 62 00 01>, byteLength: 4 }
```

--------------------------------

### WebConn _init method

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/webconn.md

Sets up the fake peer protocol, including handshake, bitfield, and request handling.

```js
_init (url) { ... }
```

--------------------------------

### Initialize WebTorrent client

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Basic usage of the WebTorrent constructor with custom connection and bandwidth limits.

```js
import WebTorrent from 'webtorrent'

const client = new WebTorrent({
  maxConns: 100,
  downloadLimit: 1_000_000, // 1 MB/s
  uploadLimit: -1
})

client.on('ready', () => console.log('client ready'))
client.on('error', err => console.error('fatal:', err))
```

--------------------------------

### torrent.rescanFiles usage example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/torrent.md

Example usage of rescanFiles with a callback to handle completion or errors.

```js
torrent.rescanFiles(err => {
  if (err) return console.error(err)
  console.log('rescan complete, progress:', torrent.progress)
})
```

--------------------------------

### client.destroy usage example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Example of calling client.destroy with a callback to handle completion or errors.

```js
client.destroy(err => {
  if (err) console.error(err)
  console.log('client closed')
})
```

--------------------------------

### GET /

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/endpoints.md

Serves the index page listing all torrents. Supports GET and HEAD methods.

```APIDOC
## [GET] /

### Description
Serves the index page listing all torrents.

### Method
GET, HEAD

### Endpoint
/

### Response
#### Success Response (200)
- Index page listing all torrents

#### Response Example
HTML page listing all torrents
```

--------------------------------

### client.add basic usage

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Example of adding a torrent with a magnet URI and a custom download path, including an ontorrent callback and an infoHash event listener.

```js
const torrent = client.add(magnetURI, { path: '/downloads' }, torrent => {
  console.log('ready:', torrent.infoHash)
})
torrent.on('infoHash', () => console.log('infoHash known'))
```

--------------------------------

### torrent.destroy usage example

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/torrent.md

Example of destroying a torrent and optionally destroying the underlying file store.

```js
torrent.destroy({ destroyStore: true }, err => {
  if (err) console.error(err)
})
```

--------------------------------

### Quick example: stream torrent file to video

Source: https://github.com/webtorrent/webtorrent/blob/master/docs/api.md

Creates a WebTorrent client, registers a service worker, adds a torrent by magnet link, and streams the first .mp4 file to a video element. Requires WebRTC support in the browser.

```javascript
const client = new WebTorrent()

const torrentId = 'magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10&dn=Sintel&tr=udp%3A%2F%2Fexplodie.org%3A6969&tr=udp%3A%2F%2Ftracker.coppersurfer.tk%3A6969&tr=udp%3A%2F%2Ftracker.empire-js.us%3A1337&tr=udp%3A%2F%2Ftracker.leechers-paradise.org%3A6969&tr=udp%3A%2F%2Ftracker.opentrackr.org%3A1337&tr=wss%3A%2F%2Ftracker.btorrent.xyz&tr=wss%3A%2F%2Ftracker.fastcast.nz&tr=wss%3A%2F%2Ftracker.openwebtorrent.com&ws=https%3A%2F%2Fwebtorrent.io%2Ftorrents%2F&xs=https%3A%2F%2Fwebtorrent.io%2Ftorrents%2Fsintel.torrent'

const controller = await navigator.serviceWorker.register('./sw.min.js', { scope: './' })
await navigator.serviceWorker.ready
client.createServer({ controller })

client.add(torrentId, torrent => {
  // Torrents can contain many files. Let's use the .mp4 file
  const file = torrent.files.find(file => {
    return file.name.endsWith('.mp4')
  })

  // Display the file by adding it to the DOM. Supports video, audio, image, etc. files
  file.streamTo(document.querySelector('video'))
})
```

--------------------------------

### client.createServer(options, force)

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/configuration.md

Creates a WebTorrent server instance. Options control CORS, hostname validation, base path, service worker registration, and runtime implementation selection.

```APIDOC
## client.createServer(options, force)

### Description
Creates a WebTorrent server instance. Options control CORS, hostname validation, base path, service worker registration, and runtime implementation selection.

### Method
createServer

### Parameters
#### Options
- **origin** (string | false) - Optional - Allowed CORS origin. '*' = all, false = same-origin only, string = exact Origin match. Default: '*'
- **hostname** (string) - Optional - (Node.js) Only allow requests whose Host header matches <hostname>:<port> (DNS-rebinding protection). Do not include the port.
- **pathname** (string) - Optional - (Node.js) Base path. Browser pathname is scope.pathname + 'webtorrent'. Default: '/webtorrent'
- **controller** (ServiceWorkerRegistration) - Required in browser - Service worker registration (e.g. await navigator.serviceWorker.getRegistration()).
- **force** ('browser' | 'node') - Optional - Force an implementation in dual-runtime environments (Electron/NW.js).

### Environment Variables and Globals
- **DEBUG** (string) - (Node.js) Enables debug module logs, e.g. DEBUG=webtorrent*, DEBUG=*. In the browser, use localStorage.setItem('debug', '*').
- **global.WEBTORRENT_ANNOUNCE** (Array<string>) - If set (e.g. by webtorrent-hybrid), these trackers are appended to every non-private torrent's announce list.
- **globalThis.WRTC** (WebRTC implementation) - If set and opts.tracker is an object without wrtc, it is assigned as tracker.wrtc (used by bittorrent-tracker in Node).
```

--------------------------------

### client.add(torrentId, opts, ontorrent)

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Starts downloading a new torrent. Accepts a magnet URI, torrent file, info hash, parsed torrent, URL, or filesystem path. Returns a Torrent instance usable immediately for event listeners.

```APIDOC
## client.add(torrentId, opts, ontorrent)

### Description
Starts downloading a new torrent. Accepts a magnet URI, torrent file, info hash, parsed torrent, URL, or filesystem path. Returns a Torrent instance usable immediately for event listeners.

### Method Signature
add (torrentId, opts = {}, ontorrent = () => {})

### Parameters
- **torrentId** (string | Buffer | Object) - Required - Magnet URI, torrent file (Uint8Array/Buffer), info hash, parsed torrent, http(s) URL, or filesystem path (Node.js only).
- **opts** (TorrentOpts) - Optional - Torrent options, see types.md and configuration.md. If a function is passed it is treated as ontorrent.
- **ontorrent** (function(torrent: Torrent): void) - Optional - Called when this torrent is ready (has metadata).

### Returns
- **Torrent** - The new torrent instance (usable immediately for event listeners).

### Throws
- **Error('client is destroyed')** - If the client was destroyed.

### Behavior
Duplicate info hashes are detected on the private _infoHash event; the new torrent is destroyed with Error('Cannot add duplicate torrent <infoHash>') and ontorrent is invoked with the existing torrent instead. Emits 'add' immediately and 'torrent' when ready.

### Example - Basic
```js
const torrent = client.add(magnetURI, { path: '/downloads' }, torrent => {
  console.log('ready:', torrent.infoHash)
})
torrent.on('infoHash', () => console.log('infoHash known'))
```

### Example - Error Handling
```js
const torrent = client.add(torrentId)
torrent.on('error', err => console.error('torrent error:', err.message))
torrent.on('warning', err => console.warn('warning:', err.message))
```
```

--------------------------------

### file.arrayBuffer(opts)

Source: https://github.com/webtorrent/webtorrent/blob/master/docs/api.md

Gets the file contents as an ArrayBuffer. Optional opts can be used to get only a part of the ArrayBuffer.

```APIDOC
## file.arrayBuffer(opts)

### Description
Get the file contents as an ArrayBuffer. You can pass opts to get only a part of an ArrayBuffer.

### Method
arrayBuffer

### Endpoint
file.arrayBuffer(opts)

### Parameters
#### Options
- **start** (number) - Optional - Start byte (inclusive)
- **end** (number) - Optional - End byte (inclusive)

### Response
Returns a Promise that resolves to an ArrayBuffer.

### Example
```js
const data = await file.arrayBuffer()
console.log(data) // ArrayBuffer { [Uint8Contents]: <00 62 00 01>, byteLength: 4 }
```
```

--------------------------------

### new WebTorrent(opts)

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Creates a new WebTorrent client instance. The constructor accepts an options object to configure the client.

```APIDOC
## new WebTorrent(opts)

### Description
Creates a new WebTorrent client instance. The constructor accepts an options object to configure the client.

### Method
Constructor

### Parameters
#### Constructor Options
- **opts** (object) - Optional - Configuration options for the client.

### Example
```js
const client = new WebTorrent()
```
```

--------------------------------

### GET /<infoHash>

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/endpoints.md

Serves the torrent page listing files for a specific torrent identified by its info hash. Supports GET and HEAD methods.

```APIDOC
## [GET] /<infoHash>

### Description
Serves the torrent page listing files for a specific torrent.

### Method
GET, HEAD

### Endpoint
/<infoHash>

### Parameters
#### Path Parameters
- **infoHash** (string) - Required - The info hash of the torrent

### Response
#### Success Response (200)
- Torrent page listing files

#### Response Example
HTML page listing files for the torrent
```

--------------------------------

### new WebTorrent(opts)

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Creates a new WebTorrent client instance with optional configuration options. The constructor initializes peer ID, DHT node, throttle groups, and optionally starts a DHT node and loads a blocklist.

```APIDOC
## new WebTorrent(opts)

### Description
Creates a new WebTorrent client instance. The constructor generates a peer ID and DHT node ID, sets up throttle groups, optionally starts a DHT node, and loads a blocklist if provided. Emits 'ready' once the blocklist is loaded.

### Method
Constructor

### Parameters
#### Constructor Parameters
- **opts** (Object) - Optional - Client options, see configuration.md. Default: {}.

### Request Example
```js
import WebTorrent from 'webtorrent'

const client = new WebTorrent({
  maxConns: 100,
  downloadLimit: 1_000_000, // 1 MB/s
  uploadLimit: -1
})

client.on('ready', () => console.log('client ready'))
client.on('error', err => console.error('fatal:', err))
```

### Response
#### Events
- **ready** - Emitted when the client is ready.
- **error** - Emitted when a fatal error occurs (e.g., DHT failure). The client is automatically destroyed.

### Error Handling
- DHT errors are forwarded to client.on('error') via _destroy(err).
```

--------------------------------

### GET /<infoHash>/<filePath>

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/endpoints.md

Serves the content of a specific file within a torrent. Supports range requests, returning 206 Partial Content when a range is specified. Supports GET and HEAD methods.

```APIDOC
## [GET] /<infoHash>/<filePath>

### Description
Serves the content of a specific file within a torrent, with range-request support.

### Method
GET, HEAD

### Endpoint
/<infoHash>/<filePath>

### Parameters
#### Path Parameters
- **infoHash** (string) - Required - The info hash of the torrent
- **filePath** (string) - Required - The path to the file within the torrent

### Response
#### Success Response (200)
- File content

#### Success Response (206)
- Partial file content (when a range header is provided)

#### Response Example
File content (binary)
```

--------------------------------

### WebConn constructor

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/webconn.md

Initializes a new WebConn instance with a web seed URL and the owning torrent.

```js
constructor (url, torrent) {
  super()
  this.url = url
  this.connId = url // Unique id to deduplicate web seeds
  this._torrent = torrent
  this._init(url)
}
```

--------------------------------

### torrent.select(start, end, priority, notify)

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/torrent.md

Selects a range of pieces for downloading. Accepts start and end piece indices, an optional priority, and an optional notify callback. Throws errors for invalid selections or if the torrent is destroyed.

```APIDOC
## torrent.select(start, end, priority, notify)

### Description
Selects a range of pieces for downloading. Accepts start and end piece indices, an optional priority, and an optional notify callback. Throws errors for invalid selections or if the torrent is destroyed.

### Method
select

### Parameters
- **start** (number) - Required - First piece index (inclusive).
- **end** (number) - Required - Last piece index (inclusive).
- **priority** (number) - Optional - Default: 0 - Selection priority (higher = downloaded first).
- **notify** (function(): void) - Optional - Called when the selection is updated with new data.

### Throws
- Error('torrent is destroyed')
- Error('invalid selection <start> : <end>') if start < 0, end < start, or end >= pieces.length.

### Example
```js
torrent.select(0, 10, 1, () => console.log('selection progressed'))
```
```

--------------------------------

### client.ratio (getter)

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Gets the overall upload/download ratio.

```APIDOC
## client.ratio (getter)

### Description
Gets the overall upload/download ratio.

### Property
ratio

### Returns
number - Upload/download ratio.

### Example
```js
const ratio = client.ratio
```
```

--------------------------------

### GET /favicon.ico

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/endpoints.md

Returns 404 Not Found for favicon requests.

```APIDOC
## [GET] /favicon.ico

### Description
Returns 404 Not Found for favicon requests.

### Method
GET, HEAD

### Endpoint
/favicon.ico

### Response
#### Error Response (404)
- Not found
```

--------------------------------

### Configure client.createServer options

Source: https://github.com/webtorrent/webtorrent/blob/master/docs/api.md

The options object for client.createServer, defining origin, hostname, path, and service worker controller.

```js
{
  origin: String // Allow requests from specific origin. `false` for same-origin. [default: '*']
  hostname: String // If specified, only allow requests whose `Host` header matches this hostname. Note that you should not specify the port since this is automatically determined by the server. Ex: `localhost` [default: `undefined`]. NodeJS only.
  path: String // Allows to overwrite the default `/webtorrent` base path. [default: '/webtorrent']. NodeJS only.
  controller: ServiceWorkerRegistration // Accepts an existing service worker registration [await navigator.serviceWorker.getRegistration()]. Browser only. Required!
}
```

--------------------------------

### Import WebTorrent in bundlers

Source: https://github.com/webtorrent/webtorrent/blob/master/docs/get-started.md

Import the WebTorrent module after installation via npm.

```javascript
import WebTorrent from 'webtorrent'
```

--------------------------------

### file.streamTo() browser usage

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/file.md

Example of streaming a file to a video element in the browser.

```js
const video = document.querySelector('video')
file.streamTo(video)
```

--------------------------------

### new RarityMap(torrent) constructor

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/rarity-map.md

Initializes availability tracking for existing wires and subscribes to new 'wire' events.

```js
constructor (torrent) {
  this._torrent = torrent
  this._numPieces = torrent.pieces.length
  this._pieces = new Array(this._numPieces)
  this._onWire = wire => {
    this.recalculate()
    this._initWire(wire)
  }
  this._onWireHave = index => { this._pieces[index] += 1 }
  this._onWireBitfield = () => { this.recalculate() }
  this._torrent.wires.forEach(wire => { this._initWire(wire) })
  this._torrent.on('wire', this._onWire)
  this.recalculate()
}
```

--------------------------------

### client.seed seeding a Buffer

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Example of seeding a Uint8Array buffer with a specified name.

```js
const buf = new Uint8Array('hello world')
buf.name = 'hello.txt'
const torrent = client.seed(buf, torrent => {
  console.log('seeding', torrent.name)
})
```

--------------------------------

### Create Node.js server

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Creates a server instance in a Node.js environment and listens on an available port.

```js
const client = new WebTorrent()
const server = client.createServer()
server.listen(0, () => {
  console.log('listening on', server.address().port)
})
```

--------------------------------

### client.progress (getter)

Source: https://github.com/webtorrent/webtorrent/blob/master/_autodocs/api-reference/client.md

Gets the overall download progress as a number between 0 and 1.

```APIDOC
## client.progress (getter)

### Description
Gets the overall download progress as a number between 0 and 1.

### Property
progress

### Returns
number - Progress value from 0 to 1.

### Example
```js
const progress = client.progress
```
```
Tokens:
Raw