Webtorrent-web-gui NPM

Webtorrent web gui

This project need an associated "Webtorrent express api" to work

Prop Types

Props to pass to the UI component

Property	Type	Required?	Description
host	String	true	The host where you run the service. If you start the other project locally is http://localhost
port	Number	true	The port where you run the service. If you start the other project locally is 3000
baseUrl	String	true	Contains the URL for the API, example "http://localhost:3000"
remote	Boolean	false	If true consider the API on a remote machine, and open remote link
logo	url	false	If will be passed an image this will be used as logo in the UI

Examples

Here is an example of the use of the component with the UI

import {WebTorrentGui} from 'webtorrent-web-gui';


function App() {

    return (
        <div className="App">
            <WebTorrentGui host={"http://localhost"} port={3000}/>
        </div>
    );
}

export default App;

Prop Types

Props to pass to the Linear component

Property	Type	Description
addTorrent	Data	Add a torrent to the download list
pauseTorrent	Data	Pause a torrent
removeTorrent	Data	Remove a torrent
destroyTorrent	Data	Delete a torrent and his data
checkStatus	void	Return the list of the torrent and his status
getConf	void	Return the actual configuration of the server
saveConf	ConfigData	Save a new configuration for the server
search	String	Search a torrent list
getTorrentFile	{id,filename}	id of the file taken from checkStatus, and the name of the torrent file to download (Can be used the name of the torren or the id)

Data

magnet = Magnet of the torrent

ConfigData

downloadPath = Path of the downlaod (Default: "./Downloads/") downloadSpeed = Speed of the download (Bytes/s) uploadSpeed = Speed of the upload (Bytes/s)

Examples

Here is an example of the use of the component with the UI

import {WebTorrentHelper} from 'webtorrent-web-gui';

let client = new WebTorrentHelper({host: "http://localhost", port: 3000})
client.addTorrent({magnet: ""})