Type alias AddMagnetOptions

AddMagnetOptions: {
    downloadDir?: string;
    magnet: string;
    paused?: boolean;
}

The configuration options for adding a magnet torrent

Type declaration

  • Optional downloadDir?: string

    The download directory to use

    Example

    '/home/user/Downloads'
    
  • magnet: string

    The magnet link to add

    Example

    'magnet:?xt=urn:btih:...'
    
  • Optional paused?: boolean

    Whether or not the torrent should be added in a paused state

    Default

    false
    

Generated using TypeDoc