diff options
| author | James M Snell <jasnell@gmail.com> | 2015-06-23 20:42:49 -0700 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2015-08-03 20:44:38 -0700 |
| commit | 85bcb281e482cda82c49f4d81981d654017b8f23 (patch) | |
| tree | af613ce51fa0848fad511bfa1a4cb8e7f7f6728a /doc/api | |
| parent | cf435d55db1900b996e069738673ce1ed4cee180 (diff) | |
| download | node-85bcb281e482cda82c49f4d81981d654017b8f23.tar.gz | |
doc: improve http.abort description
Per #4409, the documentation on http.abort is a bit lacking.
This provides a slight improvement.
Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/joyent/node/pull/25591
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/http.markdown | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/api/http.markdown b/doc/api/http.markdown index 3ba57a195..bfdeb8640 100644 --- a/doc/api/http.markdown +++ b/doc/api/http.markdown @@ -897,7 +897,8 @@ is finished. ### request.abort() -Aborts a request. (New since v0.3.8.) +Marks the request as aborting. Calling this will cause remaining data +in the response to be dropped and the socket to be destroyed. ### request.setTimeout(timeout[, callback]) |