From 5a8de857f0bd05941f54b20415ab7c374c4b1720 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Maciej=20Ma=C5=82ecki?= Date: Tue, 12 Nov 2013 11:28:44 +0100 Subject: [PATCH] doc: document that `process.send` is synchronous Ref #2598 --- doc/api/child_process.markdown | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown index 7b51902..f9adadc 100644 --- a/doc/api/child_process.markdown +++ b/doc/api/child_process.markdown @@ -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. -- 2.7.4