aboutsummaryrefslogtreecommitdiff
path: root/node_modules/download/readme.md
diff options
context:
space:
mode:
authorMinteck <nekostarfan@gmail.com>2021-08-24 14:41:48 +0200
committerMinteck <nekostarfan@gmail.com>2021-08-24 14:41:48 +0200
commitd25e11bee6ca5ca523884da132d18e1400e077b9 (patch)
tree8af39fde19f7ed640a60fb397c7edd647dff1c4c /node_modules/download/readme.md
downloadkartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.tar.gz
kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.tar.bz2
kartik-iridium-d25e11bee6ca5ca523884da132d18e1400e077b9.zip
Initial commit
Diffstat (limited to 'node_modules/download/readme.md')
-rw-r--r--node_modules/download/readme.md75
1 files changed, 75 insertions, 0 deletions
diff --git a/node_modules/download/readme.md b/node_modules/download/readme.md
new file mode 100644
index 0000000..892470f
--- /dev/null
+++ b/node_modules/download/readme.md
@@ -0,0 +1,75 @@
+# download [![Build Status](https://travis-ci.org/kevva/download.svg?branch=master)](https://travis-ci.org/kevva/download)
+
+> Download and extract files
+
+*See [download-cli](https://github.com/kevva/download-cli) for the command-line version.*
+
+
+## Install
+
+```
+$ npm install download
+```
+
+
+## Usage
+
+```js
+const fs = require('fs');
+const download = require('download');
+
+(async () => {
+ await download('http://unicorn.com/foo.jpg', 'dist');
+
+ fs.writeFileSync('dist/foo.jpg', await download('http://unicorn.com/foo.jpg'));
+
+ download('unicorn.com/foo.jpg').pipe(fs.createWriteStream('dist/foo.jpg'));
+
+ await Promise.all([
+ 'unicorn.com/foo.jpg',
+ 'cats.com/dancing.gif'
+ ].map(url => download(url, 'dist')));
+})();
+```
+
+### Proxies
+
+To work with proxies, read the [`got documentation`](https://github.com/sindresorhus/got#proxies).
+
+
+## API
+
+### download(url, destination?, options?)
+
+Returns both a `Promise<Buffer>` and a [Duplex stream](https://nodejs.org/api/stream.html#stream_class_stream_duplex) with [additional events](https://github.com/sindresorhus/got#streams-1).
+
+#### url
+
+Type: `string`
+
+URL to download.
+
+#### destination
+
+Type: `string`
+
+Path to where your file will be written.
+
+#### options
+
+Type: `Object`
+
+Same options as [`got`](https://github.com/sindresorhus/got#options) and [`decompress`](https://github.com/kevva/decompress#options) in addition to the ones below.
+
+##### extract
+
+Type: `boolean`<br>
+Default: `false`
+
+If set to `true`, try extracting the file using [`decompress`](https://github.com/kevva/decompress).
+
+##### filename
+
+Type: `string`
+
+Name of the saved file.