Interface AddMagnetOptions

interface AddMagnetOptions {
    category: string;
    cookie: string;
    dlLimit: number;
    firstLastPiecePrio: TrueFalseStr;
    paused: TrueFalseStr;
    rename: string;
    root_folder: TrueFalseStr;
    savepath: string;
    sequentialDownload: TrueFalseStr;
    skip_checking: TrueFalseStr;
    tags: string;
    upLimit: number;
    useAutoTMM: TrueFalseStr;
}

Properties

category: string

Category for the torrent

cookie: string
dlLimit: number

Set torrent download speed limit. Unit in bytes/second

firstLastPiecePrio: TrueFalseStr

Prioritize download first last piece. Possible values are true, false (default)

paused: TrueFalseStr

Add torrents in the paused state. Possible values are true, false (default)

rename: string

Rename torrent

root_folder: TrueFalseStr

Create the root folder. Possible values are true, false, unset (default)

savepath: string
sequentialDownload: TrueFalseStr

Enable sequential download. Possible values are true, false (default)

skip_checking: TrueFalseStr

Skip hash checking. Possible values are true, false (default)

tags: string

Tags for the torrent, split by ','

upLimit: number

Set torrent upload speed limit. Unit in bytes/second

useAutoTMM: TrueFalseStr

Whether Automatic Torrent Management should be used, disables use of savepath