Galerie und tage

node_modules/download/readme.md

@@ -14,71 +14,111 @@ $ npm install --save download
 
 ## Usage
 
+If you're fetching an archive you can set `extract: true` in options and
+it'll extract it for you.
+
 ```js
-const fs = require('fs');
-const download = require('download');
+var Download = require('download');
 
-download('http://unicorn.com/foo.jpg', 'dist').then(() => {
-	console.log('done!');
-});
-
-download('http://unicorn.com/foo.jpg').then(data => {
-	fs.writeFileSync('dist/foo.jpg', data);
-});
-
-download('unicorn.com/foo.jpg').pipe(fs.createWriteStream('dist/foo.jpg'));
-
-Promise.all([
-	'unicorn.com/foo.jpg',
-	'cats.com/dancing.gif'
-].map(x => download(x, 'dist'))).then(() => {
-	console.log('files downloaded!');
-});
+new Download({mode: '755'})
+    .get('http://example.com/foo.zip')
+    .get('http://example.com/cat.jpg')
+    .dest('dest')
+    .run();
 ```
 
 
 ## API
 
-### download(url, [destination], [options])
+### new Download(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).
+Creates a new `Download` instance.
+
+#### options
+
+Type: `object`
+
+Options for [`got`](https://github.com/sindresorhus/got) or the underlying [`http`](https://nodejs.org/api/http.html#http_http_request_options_callback)/[`https`](https://nodejs.org/api/https.html#https_https_request_options_callback) request can be specified,
+as well as options specific to the `download` module as described below.
+
+##### options.extract
+
+Type: `boolean`  
+Default: `false`
+
+If set to `true`, try extracting the file using [decompress](https://github.com/kevva/decompress/).
+
+##### options.mode
+
+Type: `string`
+
+Set mode on the downloaded file, i.e `{mode: '755'}`.
+
+##### options.strip
+
+Type: `number`  
+Default: `0`
+
+Remove leading directory components from extracted files.
+
+### .get(url, [dest])
 
 #### url
 
 Type: `string`
 
-URL to download.
+Add a URL to download.
 
-#### destination
+#### dest
 
 Type: `string`
 
-Path to where your file will be written.
+Set an optional destination folder that will take precedence over the one set in 
+`.dest()`.
 
-#### options
+### .dest(dir)
 
-Same options as [`got`](https://github.com/sindresorhus/got) 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
+#### dir
 
 Type: `string`
 
-Name of the saved file.
+Set the destination folder to where your files will be downloaded.
 
-##### proxy
+### .rename(name)
 
-Type: `string`
+#### name
 
-Proxy endpoint.
+Type: `function` or `string`
+
+Rename your files using [gulp-rename](https://github.com/hparra/gulp-rename).
+
+### .use(plugin)
+
+#### plugin(response, url)
+
+Type: `function`
+
+Add a plugin to the middleware stack.
+
+##### response
+
+The [response object](http://nodejs.org/api/http.html#http_http_incomingmessage).
+
+##### url
+
+The requested URL.
+
+### .run(callback)
+
+#### callback(err, files)
+
+Type: `function`
+
+##### files
+
+Contains an array of vinyl files.
 
 
 ## License
 
-MIT © [Kevin Mårtensson](https://github.com/kevva)
+MIT © [Kevin Mårtensson](http://github.com/kevva)