Preliminary Node API docs

Unitech · May 25, 2011 · 90f6657 · 90f6657
1 parent 1f4f5b4
commit 90f6657
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/Node-API.md b/Node-API.md
@@ -7,6 +7,9 @@
 ```
 exports.main = function (tokens, pipes, exit) {
 
+  exit(true); // Success
+  exit(false); // Error
+  exit(true, { ... }); // Success with meta data.
 };
 ```
 
@@ -20,7 +23,7 @@ exports.main = function (tokens, pipes, exit) {
 
 `pipes` is an object with the 5 TermKit pipes: Data In/Out, View In/Out, and Error Out.
 
-`exit` is a function to call when ending the process. This call can be nested inside asynchronous closures.
+`exit` is a function to call when ending the process. This call can be nested inside asynchronous closures. Pass `true` for success, `false` for error. You can pass out additional meta-data in the second argument, though this is currently not used for anything.
 
 ## Pipes