From 49e719306deb5fec8202616d5a58329f2419ac65 Mon Sep 17 00:00:00 2001
From: Mathieu Ledru <mathieu@darkwood.fr>
Date: Thu, 12 Sep 2024 00:35:13 +0200
Subject: [PATCH] :memo: Add await docs

---
 src/DriverInterface.php | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/DriverInterface.php b/src/DriverInterface.php
index c33d16a..ec368ce 100644
--- a/src/DriverInterface.php
+++ b/src/DriverInterface.php
@@ -30,10 +30,13 @@ public function async(Closure|JobInterface $callback): Closure;
     public function defer(Closure $callback): mixed;
 
     /**
-     * @param array{'fnFlows': array<mixed>, 'dispatchers': array<mixed>} $stream
+     * Waits for all asynchronous operations in the stream to complete and rolls back to synchronous execution.
+     *
+     * @param array{'fnFlows': array<mixed>, 'dispatchers': array<mixed>} $stream The stream containing asynchronous operations to await
      */
     public function await(array &$stream): void;
 
+
     public function delay(float $seconds): void;
 
     /**