Update docs

Author: hdgarrood

docs/Node/Stream.md

@@ -5,7 +5,7 @@ This module provides a low-level wrapper for the Node Stream API.
 #### `Stream`
 
 ``` purescript
-data Stream :: # * -> # ! -> * -> *
+data Stream :: # * -> # ! -> *
 ```
 
 A stream.
@@ -14,7 +14,6 @@ The type arguments track, in order:
 
 - Whether reading and/or writing from/to the stream are allowed.
 - Effects associated with reading/writing from/to this stream.
-- The type of chunks which will be read from/written to this stream (`String` or `Buffer`).
 
 #### `Read`
 
@@ -59,119 +58,136 @@ A duplex (readable _and_ writable stream)
 #### `setEncoding`
 
 ``` purescript
-setEncoding :: forall w eff. Readable w eff String -> Encoding -> Eff eff Unit
+setEncoding :: forall w eff. Readable w eff -> Encoding -> Eff eff Unit
 ```
 
-Set the encoding used to read chunks from the stream.
+Set the encoding used to read chunks as strings from the stream. This
+function is useful when you are passing a readable stream to some other
+JavaScript library, which already expects an encoding to be set. It
+has no effect on the behaviour of the `onDataString` function (because
+that function ensures that the encoding is always supplied explicitly).
 
 #### `onData`
 
 ``` purescript
-onData :: forall w eff a. Readable w eff a -> (a -> Eff eff Unit) -> Eff eff Unit
+onData :: forall w eff. Readable w eff -> (Buffer -> Eff eff Unit) -> Eff eff Unit
 ```
 
-Listen for `data` events.
+Listen for `data` events, returning data in a Buffer.
+
+#### `onDataString`
+
+``` purescript
+onDataString :: forall w eff. Readable w eff -> Encoding -> (String -> Eff eff Unit) -> Eff eff Unit
+```
+
+Listen for `data` events, returning data in a String, which will be
+decoded using the given encoding.
 
 #### `onEnd`
 
 ``` purescript
-onEnd :: forall w eff a. Readable w eff a -> Eff eff Unit -> Eff eff Unit
+onEnd :: forall w eff. Readable w eff -> Eff eff Unit -> Eff eff Unit
 ```
 
 Listen for `end` events.
 
 #### `onClose`
 
 ``` purescript
-onClose :: forall w eff a. Readable w eff a -> Eff eff Unit -> Eff eff Unit
+onClose :: forall w eff. Readable w eff -> Eff eff Unit -> Eff eff Unit
 ```
 
 Listen for `close` events.
 
 #### `onError`
 
 ``` purescript
-onError :: forall w eff a. Readable w eff a -> Eff eff Unit -> Eff eff Unit
+onError :: forall w eff. Readable w eff -> Eff eff Unit -> Eff eff Unit
 ```
 
 Listen for `error` events.
 
 #### `resume`
 
 ``` purescript
-resume :: forall w eff a. Readable w eff a -> Eff eff Unit
+resume :: forall w eff. Readable w eff -> Eff eff Unit
 ```
 
 Resume reading from the stream.
 
 #### `pause`
 
 ``` purescript
-pause :: forall w eff a. Readable w eff a -> Eff eff Unit
+pause :: forall w eff. Readable w eff -> Eff eff Unit
 ```
 
 Pause reading from the stream.
 
 #### `isPaused`
 
 ``` purescript
-isPaused :: forall w eff a. Readable w eff a -> Eff eff Boolean
+isPaused :: forall w eff. Readable w eff -> Eff eff Boolean
 ```
 
 Check whether or not a stream is paused for reading.
 
 #### `pipe`
 
 ``` purescript
-pipe :: forall r w eff a. Readable w eff a -> Writable r eff a -> Eff eff (Writable r eff a)
+pipe :: forall r w eff. Readable w eff -> Writable r eff -> Eff eff (Writable r eff)
 ```
 
 Read chunks from a readable stream and write them to a writable stream.
 
 #### `write`
 
 ``` purescript
-write :: forall r eff a. Writable r eff String -> a -> Eff eff Unit -> Eff eff Boolean
+write :: forall r eff. Writable r eff -> Buffer -> Eff eff Unit -> Eff eff Boolean
 ```
 
-Write a chunk to a writable stream.
+Write a Buffer to a writable stream.
 
 #### `writeString`
 
 ``` purescript
-writeString :: forall r eff. Writable r eff String -> Encoding -> String -> Eff eff Unit -> Eff eff Boolean
+writeString :: forall r eff. Writable r eff -> Encoding -> String -> Eff eff Unit -> Eff eff Boolean
 ```
 
 Write a string in the specified encoding to a writable stream.
 
 #### `cork`
 
 ``` purescript
-cork :: forall r eff a. Writable r eff a -> Eff eff Unit
+cork :: forall r eff. Writable r eff -> Eff eff Unit
 ```
 
 Force buffering of writes.
 
 #### `uncork`
 
 ``` purescript
-uncork :: forall r eff a. Writable r eff a -> Eff eff Unit
+uncork :: forall r eff. Writable r eff -> Eff eff Unit
 ```
 
 Flush buffered data.
 
 #### `setDefaultEncoding`
 
 ``` purescript
-setDefaultEncoding :: forall r eff. Writable r eff String -> Encoding -> Eff eff Unit
+setDefaultEncoding :: forall r eff. Writable r eff -> Encoding -> Eff eff Unit
 ```
 
-Set the default encoding used to write chunks to the stream.
+Set the default encoding used to write strings to the stream. This function
+is useful when you are passing a writable stream to some other JavaScript
+library, which already expects a default encoding to be set. It has no
+effect on the behaviour of the `writeString` function (because that
+function ensures that the encoding is always supplied explicitly).
 
 #### `end`
 
 ``` purescript
-end :: forall r eff a. Writable r eff a -> Eff eff Unit -> Eff eff Unit
+end :: forall r eff. Writable r eff -> Eff eff Unit -> Eff eff Unit
 ```
 
 End writing data to the stream.

docs/Node/Stream/StdIO.md

@@ -0,0 +1,23 @@
+## Module Node.Stream.StdIO
+
+The standard IO streams for the current process.
+
+#### `stdin`
+
+``` purescript
+stdin :: forall eff. Readable () (console :: CONSOLE | eff)
+```
+
+#### `stdout`
+
+``` purescript
+stdout :: forall eff. Writable () (console :: CONSOLE | eff)
+```
+
+#### `stderr`
+
+``` purescript
+stderr :: forall eff. Writable () (console :: CONSOLE | eff)
+```
+
+