https://github.com/demsking/image-downloader

A Nodejs module for downloading image to disk from a given URL
https://github.com/demsking/image-downloader

download downloader image nodejs

Last synced: 3 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/demsking/image-downloader
• Owner: demsking
• License: mit
• Created: 2016-04-21T07:28:46.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2022-08-28T03:04:52.000Z (over 2 years ago)
• Last Synced: 2024-05-22T21:25:00.943Z (9 months ago)
• Topics: download, downloader, image, nodejs
• Language: JavaScript
• Homepage: https://gitlab.com/demsking/image-downloader
• Size: 510 KB
• Stars: 70
• Watchers: 4
• Forks: 16
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Node Image Downloader

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

[![npm](https://img.shields.io/npm/v/image-downloader.svg)](https://www.npmjs.com/package/image-downloader)

[![Build status](https://gitlab.com/demsking/image-downloader/badges/main/pipeline.svg)](https://gitlab.com/demsking/image-downloader/pipelines)

[![Test coverage](https://gitlab.com/demsking/image-downloader/badges/main/coverage.svg)](https://gitlab.com/demsking/image-downloader/pipelines)

[![Buy me a beer](https://img.shields.io/badge/Buy%20me-a%20beer-1f425f.svg)](https://www.buymeacoffee.com/demsking)

## Install

```sh

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

- **maxRedirects** - the maximum number of allowed redirects; if exceeded, an

  error will be emitted. (default: `21`)

For advanced options, see [Node.js `http.request()`'s options documentation](https://nodejs.org/dist/latest-v12.x/docs/api/http.html#http_http_request_url_options_callback)

## Usage

Download to a directory and save with the original filename

```js

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

```js

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

```js

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));

```

## Development Setup

1. [Install Nix Package Manager](https://nixos.org/manual/nix/stable/installation/installing-binary.html)

2. [Install `direnv` with your OS package manager](https://direnv.net/docs/installation.html#from-system-packages)

3. [Hook it `direnv` into your shell](https://direnv.net/docs/hook.html)

4. At the top-level of your project run:

   ```sh

   direnv allow

   ```

   > The next time your launch your terminal and enter the top-level of your

   > project, `direnv` will check for changes.

## Contribute

Please follow [CONTRIBUTING.md](https://gitlab.com/demsking/image-downloader/blob/main/CONTRIBUTING.md).

## License

Under the MIT license. See [LICENSE](https://gitlab.com/demsking/image-downloader/blob/main/LICENSE) file for more details.