From fdc136df690d11a9b5b65ac58e9c1f420b24c274 Mon Sep 17 00:00:00 2001
From: Ryan Dahl
Date: Tue, 15 Sep 2009 15:25:06 +0200
Subject: [PATCH] Add documentation for promise.emitSuccess and emitError
---
doc/api.html | 21 ++++++++++++++++++++-
doc/api.txt | 10 ++++++++++
doc/node.1 | 26 ++++++++++++++++++++++++--
3 files changed, 54 insertions(+), 3 deletions(-)
diff --git a/doc/api.html b/doc/api.html
index dcae34f..6e078bf 100644
--- a/doc/api.html
+++ b/doc/api.html
@@ -280,6 +280,25 @@ Adds a listener for the "error" event. Returns the same promise object.
+promise.emitSuccess(arg1, arg2, …)
+
+
+
+If you created the promise (by doing new node.Promise()) then call
+emitSuccess to emit the "success" event with the given arguments.
+
+(promise.emit("success", arg1, arg2, …) should also work, but doesn’t at
+the moment due to a bug; use emitSuccess instead.)
+
+
+promise.emitError(arg1, arg2, …)
+
+
+
+Emits the "error" event.
+
+
+
promise.wait()
@@ -1861,7 +1880,7 @@ init (Handle<Object> target)