From b90c1502e5320f300e23724d774f634274c82daa Mon Sep 17 00:00:00 2001 From: isaacs Date: Mon, 1 Oct 2012 14:30:02 -0700 Subject: [PATCH] doc: Correct stream.write fd mention No streams actually work this way. --- doc/api/stream.markdown | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown index a894591dd9f..94141674825 100644 --- a/doc/api/stream.markdown +++ b/doc/api/stream.markdown @@ -146,7 +146,7 @@ Emitted when the stream is passed to a readable stream's pipe method. A boolean that is `true` by default, but turns `false` after an `'error'` occurred or `end()` / `destroy()` was called. -### stream.write(string, [encoding], [fd]) +### stream.write(string, [encoding]) Writes `string` with the given `encoding` to the stream. Returns `true` if the string has been flushed to the kernel buffer. Returns `false` to @@ -154,12 +154,6 @@ indicate that the kernel buffer is full, and the data will be sent out in the future. The `'drain'` event will indicate when the kernel buffer is empty again. The `encoding` defaults to `'utf8'`. -If the optional `fd` parameter is specified, it is interpreted as an -integral file descriptor to be sent over the stream. This is only -supported for UNIX streams, and is silently ignored otherwise. When -writing a file descriptor in this manner, closing the descriptor before -the stream drains risks sending an invalid (closed) FD. - ### stream.write(buffer) Same as the above except with a raw buffer.