image-downloader

    4.0.3 • Public • Published

    Node Image Downloader

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

    npm Build status Test coverage Buy me a beer

    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.

    Install

    npm i image-downloader

    DownloadsWeekly Downloads

    6,808

    Version

    4.0.3

    License

    MIT

    Unpacked Size

    9.68 kB

    Total Files

    8

    Last publish

    Collaborators

    • demsking