Document await(Promise) and await(Channel)

Raku · Feb 7, 2015 · 2c06edd · 2c06edd
1 parent deb7189
commit 2c06edd
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/lib/Type/Channel.pod b/lib/Type/Channel.pod
@@ -86,4 +86,13 @@ Closes the channel (that is, makes subsequent C<send> calls die), and enqueues
 the error as the final element in the channel. Method C<receive> will throw
 the error as an exception.
 
+=head2 sub await
+
+    multi sub await(Channel:D)
+    multi sub await(*@)
+
+Waits until all of one or more channels has a value available, and returns
+those values (it calls C<.receive> on the channel). Also works with
+L<promises|/type/Promise>.
+
 =end pod
diff --git a/lib/Type/Promise.pod b/lib/Type/Promise.pod
@@ -211,4 +211,12 @@ exception of type C<X::Promise::Vowed>.
     $vow.keep;
     say $p.status;          # Kept
 
+=head2 sub await
+
+    multi sub await(Promise:D)
+    multi sub await(*@)
+
+Waits until one or more promises are all fulfilled, and then returns their
+values. Also works on L<channels|/type/Channel>.
+
 =end pod