image-downloader

Release 4.3.0

A Nodejs module for downloading image to disk from a given URL

Homepage npm Download

Keywords
image, download, downloader, images, nodejs
License
MIT
Install
npm install image-downloader@4.3.0

Documentation

Node Image Downloader

A Node module for downloading image to disk from a given URL

npm Build status Test coverage

Install

npm install --save image-downloader

Options

  • url (required) - the image URL to download
  • dest (required) - the image destination. Can be a directory or a filename. If a directory is given, ID will automatically extract the image filename from options.url (see usage bellow)
  • extractFilename - boolean indicating whether the image filename will be automatically extracted from options.url or not. Set to false to have options.dest without a file extension for example. (default: true)
  • headers - HTTP headers (default: {})
  • timeout - milliseconds before a request times out

For advanced options, see Node.js http.request()'s options documentation

Syntax

declare module download {
  image(options: Options): Promise<{ filename: string }>;
}

Usage

Download to a directory and save with the original filename

const download = require('image-downloader')

const options = {
  url: 'http://someurl.com/image.jpg',
  dest: '/path/to/dest'                // will be saved to /path/to/dest/image.jpg
}

download.image(options)
  .then(({ filename }) => {
    console.log('Saved to', filename)  // saved to /path/to/dest/image.jpg
  })
  .catch((err) => console.error(err))

Download to a directory and save with an another filename

const download = require('image-downloader')

options = {
  url: 'http://someurl.com/image2.jpg',
  dest: '/path/to/dest/photo.jpg'      // will be saved to /path/to/dest/photo.jpg
}

download.image(options)
  .then(({ filename }) => {
    console.log('Saved to', filename)  // saved to /path/to/dest/photo.jpg
  })
  .catch((err) => console.error(err))

Download with another filename without extension

const download = require('image-downloader')

options = {
  url: 'http://someurl.com/image3.jpg',
  dest: '/path/to/dest/photo',         // will be saved to /path/to/dest/photo
  extractFilename: false
}

download.image(options)
  .then(({ filename }) => {
    console.log('Saved to', filename)  // saved to /path/to/dest/photo
  })
  .catch((err) => console.error(err))

License

Under the MIT license. See LICENSE file for more details.

Stats

Dependencies
1
Dependent packages
144
Dependent repositories
281
Total releases
21
Latest release
First release
Stars
16
Forks
1
Contributors
0
SourceRank
15

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

4.3.0
4.2.0
4.1.0
4.0.3
4.0.2
4.0.1
3.6.0
4.0.0
3.5.0
3.4.2
See all 21 releases

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2023-11-30 22:45:56 UTC

Login to resync this project