Skip to content

Commit

Permalink
Document the pretend option
Browse files Browse the repository at this point in the history
  • Loading branch information
chriso committed Feb 10, 2013
1 parent a83ee99 commit 03cbfad
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Expand Up @@ -114,6 +114,17 @@ temporary files.
Pipe the stderr of each curl process to the main process. Set this to a
string to write stderr to a file.

`pretend` - *default: false*

Useful if you want to see what curl command is to be executed without actually
making the request

```javascript
curl.request({ url: 'http://google.com', pretend: true }, function (err, stdout, meta) {
console.log('%s %s', meta.cmd, meta.args.join(' '));
});
```

### Passing options directly to curl

Any additional options are sent as command line options to curl. See `man
Expand Down

0 comments on commit 03cbfad

Please sign in to comment.