doc: document that `process.send` is synchronous
authorMaciej Małecki <me@mmalecki.com>
Tue, 12 Nov 2013 10:28:44 +0000 (11:28 +0100)
committerTimothy J Fontaine <tjfontaine@gmail.com>
Tue, 31 Dec 2013 22:52:43 +0000 (14:52 -0800)
Ref #2598

doc/api/child_process.markdown

index 7b51902..f9adadc 100644 (file)
@@ -194,6 +194,11 @@ And then the child script, `'sub.js'` might look like this:
 In the child the `process` object will have a `send()` method, and `process`
 will emit objects each time it receives a message on its channel.
 
+Please note that the `send()` method on both the parent and child are
+synchronous - sending large chunks of data is not advised (pipes can be used
+instead, see
+[`child_process.spawn`](#child_process_child_process_spawn_command_args_options)).
+
 There is a special case when sending a `{cmd: 'NODE_foo'}` message. All messages
 containing a `NODE_` prefix in its `cmd` property will not be emitted in
 the `message` event, since they are internal messages used by node core.