Download is in {isInProgress ? 'in progress' : 'stopped'}
download(fileUrl, filename)}>
Click to download the file
cancel()}>Cancel the download
Download size in bytes {size}
Downloading progress:
Elapsed time in seconds {elapsed}
{error &&
possible error {JSON.stringify(error)}
}
);
}
```
---
## Documentation
`useDownloader()` returns:
- An object with the following keys:
| key | description | arguments |
| ------------ | -------------------------------- | ------------------------------------------------------------------------------------------------- |
| size | size in bytes | n/a |
| elapsed | elapsed time in seconds | n/a |
| percentage | percentage in string | n/a |
| download | download function handler | (downloadUrl: string, filename: string, timeout?: number, overrideOptions?: UseDownloaderOptions) |
| cancel | cancel function handler | n/a |
| error | error object from the request | n/a |
| isInProgress | boolean denoting download status | n/a |
```jsx
const { size, elapsed, percentage, download, cancel, error, isInProgress } =
useDownloader();
```
`useDownloader(options?: UseDownloaderOptions)` also accepts fetch's RequestInit options:
- Ex.:
```jsx
const { download } = useDownloader({
mode: 'no-cors',
credentials: 'include',
headers: {
Authorization: 'Bearer TOKEN',
},
});
```
---
## Contributors β¨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
