JSPM

async-get-file

1.0.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 250
  • Score
    100M100P100Q84411F
  • License MIT

A wrapper around download-file package to make it return a promise.

Package Exports

  • async-get-file

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (async-get-file) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

async-get-file : Download files with Promise (Node.js)

npm npm NPM

This package is a wrapper around the download-file package replacing callback functions with functions that return a Promise.

Basically it lets you write code like this

await get(url,options);
console.log("Success");

instead of

get(url, options, err => {
    if (err) throw err;
    console.log("Success");
}) 

Installation

NPM

Basic Usage

const async = require("async");
const get = require("async-get-file");

async function main(){
  var url = "http://i.imgur.com/G9bDaPH.jpg";
  var options = {
    directory: "./images/cats/",
    filename: "cat.gif"
  }
  await get(url,options);
}

main();

Or

const Promise = require("promise");
const get = require("async-get-file");

var url = "http://i.imgur.com/G9bDaPH.jpg";
var options = {
  directory: "./images/cats/",
  filename: "cat.gif"
  }

get(url,options)
.catch(err => {
      console.log(err);
      });

API

get(url, [options])

  • url string of the file URL to download

  • options object with options

    • directory string with path to directory where to save files (default: current working directory)
    • filename string for the name of the file to be saved as (default: filename in the url)
    • timeout integer of how long in ms to wait while downloading (default: 20000)

References

License

async-get-file is published under the MIT license. For more information, see the accompanying LICENSE file.