Skip to content

Gun-Vue docs v0.24.1


Gun-Vue docs / files/useTorrent / useTorrent

Function: useTorrent()

useTorrent(): object

Defined in: src/files/useTorrent.js:73

Returns

object

clearFiles()

clearFiles: () => Promise<void>

Returns

Promise<void>

clearOPFS()

clearOPFS: () => Promise<void>

Returns

Promise<void>

deleteFile()

deleteFile: (filename) => Promise<void>

Parameters

filename

any

Returns

Promise<void>

download()

download: (id) => Promise<any>

Parameters

id

any

Returns

Promise<any>

downloadStatus

downloadStatus: object

downloadStatus.done

done: boolean = false

downloadStatus.downloaded

downloaded: number = 0

downloadStatus.downloadSpeed

downloadSpeed: number = 0

downloadStatus.progress

progress: number = 0

files

files: Reactive<Map<any, any>>

init()

init: () => Promise<boolean>

Returns

Promise<boolean>

initialized

initialized: Ref<boolean, boolean>

trackers

trackers: RemovableRef<string[]>

upload()

upload: (inputFiles) => Promise<any[]>

Parameters

inputFiles

any

Returns

Promise<any[]>

MIT