FilePizza Client API

The filepizza-client API provides bindings to FilePizza server. FilePizza is a React library for browser-to-browser file transfer using WebRTC. It allows you to integrate peer-to-peer file sharing functionality into your web applications.

Features

• Direct browser-to-browser file transfers (no server storage)
• Password protection for transfers
• Support for single and multiple file transfers
• Progress tracking and event notifications

Installation

npm install filepizza-client

Usage

Set up a FilePizza client instance and use it to upload files:

import { FilePizzaUploader } from 'filepizza-client';

const uploader = new FilePizzaUploader({
  filePizzaServerUrl: 'https://your-filepizza-server.com',
  // You can optionally specify an additional shared slug where multiple uploaders can connect and share files
  sharedSlug: 'filepizza-demo'
});

await uploader.initialize();

uploader.on('progress', (progressInfo) => {
  console.log(`Upload progress: ${progressInfo.overallProgress * 100}%`);
});

uploader.setFiles(fileList); // From an input element
const links = uploader.getShareableLinks();
console.log(`Shareable links: ${links.join(', ')}`);

Set up a FilePizza client instance and use it to download files:

import { FilePizzaDownloader } from 'filepizza-client';

const downloader = new FilePizzaDownloader({
  filePizzaServerUrl: 'https://your-filepizza-server.com'
});

await downloader.initialize();

downloader.on('progress', (progressInfo) => {
  console.log(`Download progress: ${progressInfo.overallProgress * 100}%`);
});

await downloader.connect(filePizzaUrl);
await downloader.startDownload();

Examples

Regular Example

Make sure to have the FilePizza server running locally or specify the server URL in the example code.

By default, the example uses https://filepizza.texlyre.org as the demo server URL. This server allows origins from http://localhost:8081 so you can immediately test the API without requiring to run the server locally.

WARNING: The demo server (signaling and TURN as fallback) is not intended for production use and may be subject to rate limits or downtime. For production use, consider setting up your own FilePizza server.

To run the vite-bundled example locally, clone the repository and run:

npm install
npm run build:example
npm run example

Then open http://localhost:8081 in your browser.