Skip to content

Commit

Permalink
doc full API in README
Browse files Browse the repository at this point in the history
  • Loading branch information
thrackle committed Dec 4, 2015
1 parent 7b1553c commit c1523a1
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,21 @@ app.listen(3000);

$ npm install express-zip

## Full API

```js
/**
* Respond with a ZIP attachment containting `files`, with an optional
* "save as" `filename` (default is attachment.zip), and then call `cb`
* when finished.
*
* @param {Array} files { name: <name>, path: <path> }
* @param {String|Function} filename that will be shown in "save as" dialog
* @param {Function} cb(err, bytesZipped) optional
*/
res.zip = function(files, filename, cb) {
```
## Credits
Borrows heavily from nulltask's [express-csv](https://github.com/nulltask/express-csv), uses
Expand Down

0 comments on commit c1523a1

Please sign in to comment.