Gulp-Download-Stream - Downloading Files Made Easy with Gulp

Gulp-Download-Stream is a Gulp plugin that allows you to easily download files in a Gulp stream. With just a few lines of code, you can download files from any HTTP/HTTPS endpoint and add them to your Gulp stream. The plugin provides a simple and efficient way to download files, making it a great addition to your Gulp toolset.

Installation

You can install the Gulp-Download-Stream plugin using npm:

npm install gulp-download-stream

Usage

To use the Gulp-Download-Stream plugin, first import it into your project:

const download = require("gulp-download-stream");

You can then use the download function to download files in your Gulp stream. Here's an example:

const { src, dest } = require("gulp");

function downloadFiles() {
  return download({
    urls: [
      "https://example.com/file1.txt",
      "https://example.com/file2.txt",
      "https://example.com/file3.txt",
    ],
  }).pipe(dest("dist"));
}

exports.default = downloadFiles;

In this example, we're downloading three files from example.com and adding them to the dist directory. You can pass an array of URLs to the download function to download multiple files at once.

Options

The download function takes an options object as its argument. Here are the available options:

• urls (required): An array of URLs to download files from.
• fileNames: An array of filenames to use for the downloaded files. The filenames should match the order of the corresponding URLs. If not provided, the plugin will use the original filename from the URL.
• method: The HTTP method to use for the requests. Defaults to "GET".
• headers: An object of HTTP headers to include in the requests. Defaults to an empty object.
• requestOptions: Additional request options to be passed to the http.request function.

Conclusion

Gulp-Download-Stream is a simple yet powerful plugin that can help you easily download files in your Gulp stream. By using this plugin, you can automate the process of downloading files from your project's dependencies or external endpoints.