summaryrefslogtreecommitdiff
path: root/doc/node.1
diff options
context:
space:
mode:
authorRyan Dahl <ry@tinyclouds.org>2009-09-15 15:25:06 +0200
committerRyan Dahl <ry@tinyclouds.org>2009-09-15 15:25:06 +0200
commitfdc136df690d11a9b5b65ac58e9c1f420b24c274 (patch)
tree8545a70b44d946797ca133995c4fd6d3d7091325 /doc/node.1
parent7fa694a3b68b180e7b355787da74ee8943fca6d8 (diff)
downloadandroid-node-v8-fdc136df690d11a9b5b65ac58e9c1f420b24c274.tar.gz
android-node-v8-fdc136df690d11a9b5b65ac58e9c1f420b24c274.tar.bz2
android-node-v8-fdc136df690d11a9b5b65ac58e9c1f420b24c274.zip
Add documentation for promise.emitSuccess and emitError
Diffstat (limited to 'doc/node.1')
-rw-r--r--doc/node.126
1 files changed, 24 insertions, 2 deletions
diff --git a/doc/node.1 b/doc/node.1
index 9ae853dfbc..fa7b81d33a 100644
--- a/doc/node.1
+++ b/doc/node.1
@@ -1,11 +1,11 @@
.\" Title: node
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\" Date: 09/13/2009
+.\" Date: 09/15/2009
.\" Manual:
.\" Source:
.\"
-.TH "NODE" "1" "09/13/2009" "" ""
+.TH "NODE" "1" "09/15/2009" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -236,6 +236,28 @@ Adds a listener for the
event\. Returns the same promise object\.
.RE
.PP
+promise\.emitSuccess(arg1, arg2, \&...)
+.RS 4
+If you created the promise (by doing
+new node\.Promise()) then call
+emitSuccess
+to emit the
+"success"
+event with the given arguments\.
+.sp
+(promise\.emit("success", arg1, arg2, \&...)
+should also work, but doesn\(cqt at the moment due to a bug; use
+emitSuccess
+instead\.)
+.RE
+.PP
+promise\.emitError(arg1, arg2, \&...)
+.RS 4
+Emits the
+"error"
+event\.
+.RE
+.PP
promise\.wait()
.RS 4
Blocks futher execution until the promise emits a success or error event\. Events setup before the call to