From 143cd87c95ba549540e9a7b6aee3d6a15084a679 Mon Sep 17 00:00:00 2001 From: Andrew Smith Date: Wed, 7 Jan 2015 12:53:17 -0800 Subject: [PATCH] Fix documentation typo: "turn of listeners" Changes to "Passing null turns off the data listeners" --- lib/main.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/main.js b/lib/main.js index fa3633f..2694a44 100644 --- a/lib/main.js +++ b/lib/main.js @@ -99,7 +99,7 @@ exports.createHttpClient = function(options) { * HTTP GET method wrapper * * @param {module:request~options} options The options Object taken by the {@link Request} constructor, filtered by {@link module:tools.shortHand}. options.method = 'GET' and it can not be overridden - * @param {String|null} file Optional; specify a filesystem path to save the response body as file instead of Buffer. Passing null turns of the data listeners + * @param {String|null} file Optional; specify a filesystem path to save the response body as file instead of Buffer. Passing null turns off the data listeners * @param {module:main~callback} callback Completion callback * * @example @@ -187,7 +187,7 @@ exports.head = function(options, callback) { * HTTP DELETE method wrapper * * @param {module:request~options} options The options Object taken by the {@link Request} constructor, filtered by {@link module:tools.shortHand}. options.method = 'DELETE' and it can not be overridden - * @param {String|null} file Optional; specify a filesystem path to save the response body as file instead of Buffer. Passing null turns of the data listeners + * @param {String|null} file Optional; specify a filesystem path to save the response body as file instead of Buffer. Passing null turns off the data listeners * @param {module:main~callback} callback Completion callback * * @example @@ -222,7 +222,7 @@ exports.delete = function(options, file, callback) { * HTTP POST method wrapper * * @param {module:request~options} options The options Object taken by the {@link Request} constructor, filtered by {@link module:tools.shortHand}. options.method = 'POST' and it can not be overridden - * @param {String|null} file Optional; specify a filesystem path to save the response body as file instead of Buffer. Passing null turns of the data listeners + * @param {String|null} file Optional; specify a filesystem path to save the response body as file instead of Buffer. Passing null turns off the data listeners * @param {module:main~callback} callback Completion callback * * @example @@ -324,7 +324,7 @@ exports.post = function(options, file, callback) { * HTTP PUT method wrapper * * @param {module:request~options} options The options Object taken by the {@link Request} constructor, filtered by {@link module:tools.shortHand}. options.method = 'PUT' and it can not be overridden - * @param {String|null} file Optional; specify a filesystem path to save the response body as file instead of Buffer. Passing null turns of the data listeners + * @param {String|null} file Optional; specify a filesystem path to save the response body as file instead of Buffer. Passing null turns off the data listeners * @param {module:main~callback} callback Completion callback * * @example @@ -539,4 +539,4 @@ exports.setMaxSockets = function(value) { * @callback module:main~callback * @param {module:request~stdError} error The standard error or *null* on success * @param {module:request~stdResult} result The standard result object if error is null - */ \ No newline at end of file + */