Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Document the pretend option

  • Loading branch information...
commit 03cbfadd1dfa85238099453d376c50d8b99a9441 1 parent a83ee99
@chriso authored
Showing with 11 additions and 0 deletions.
  1. +11 −0 README.md
View
11 README.md
@@ -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
Please sign in to comment.
Something went wrong with that request. Please try again.