proload
File & Buffer URI downloader with a progress bar, compatible with ora.
TOC
Install
npm i -D proload
Features
- Ora optional integration (= ability to attach an existing ora instance).
- Automatically creates the destination directory if it does not exist.
- Can return a buffer of the data instead of creating a new file.
API
proloaduri: string, options?: Object: Promise<Buffer>proloaduri: string, destFilePath: string, options?: Object: Promise<Buffer>
Options
Examples
Download to Buffer
; async { const dataBuffer = await ; console;};
Download to File
; async { await ;};
Existing Ora Spinner
;; const spinner = ; async { const uri = "https://www.gutenberg.org/files/308/308-h.zip"; const options = spinner: instance: spinner ; const dataBuffer = await ; // Or: await ; // Don't forget that the spinner is on your side, so you will have to stop it yourself // or do something else with it: spinner;};
Known Issues
If you want to use rimraf or make-dir before calling proload()
in your code, you will have to use the .sync()
method instead of the await
mode. I don't know
yet why this issue happens and will try my best to find a fix.
Contribute
Get Started
npm i
Test
- All Tests:
npm test
- Lint Tests:
npm run test:lint
- Unit Tests:
npm run test:unit
- Unit Tests (watch):
npm run test:watch