Documentation

Author: groue

README.md

@@ -160,6 +160,8 @@ There are various publisher expectations. Each one waits for a specific publishe
 
 :arrow_right: Related expectations: [elements], [prefix(maxLength)].
 
+Unlike other expectations, `availableElements` does not make a test fail on timeout expiration. It just returns the elements published so far.
+
 Example:
 
 ```swift

Sources/CombineExpectations/PublisherExpectations/AvailableElements.swift

@@ -5,11 +5,14 @@ extension PublisherExpectations {
     /// the recorded publisher to complete.
     ///
     /// When waiting for this expectation, the publisher error is thrown if
-    /// the publisher fails before the expectation has expired..
+    /// the publisher fails before the expectation has expired.
     ///
     /// Otherwise, an array of all elements published before the expectation
     /// has expired is returned.
     ///
+    /// Unlike other expectations, `AvailableElements` does not make a test fail
+    /// on timeout expiration. It just returns the elements published so far.
+    ///
     /// For example:
     ///
     ///     // SUCCESS: no timeout, no error

Sources/CombineExpectations/Recorder.swift

@@ -288,17 +288,27 @@ extension PublisherExpectations {
 }
 
 extension Recorder {
-    /// Returns a publisher expectation which waits for the timeout to expire.
+    /// Returns a publisher expectation which waits for the timeout to expire,
+    /// or the recorded publisher to complete.
     ///
-    /// When waiting for this expectation, the publisher error is thrown if the
-    /// publisher fails before expiration.
+    /// When waiting for this expectation, the publisher error is thrown if
+    /// the publisher fails before the expectation has expired.
     ///
     /// Otherwise, an array of all elements published before the expectation
     /// has expired is returned.
     ///
+    /// Unlike other expectations, `availableElements` does not make a test fail
+    /// on timeout expiration. It just returns the elements published so far.
+    ///
     /// For example:
     ///
-    ///     // TODO
+    ///     // SUCCESS: no timeout, no error
+    ///     func testTimerPublishesIncreasingDates() throws {
+    ///         let publisher = Timer.publish(every: 0.01, on: .main, in: .common).autoconnect()
+    ///         let recorder = publisher.record()
+    ///         let dates = try wait(for: recorder.availableElements, timeout: ...)
+    ///         XCTAssertEqual(dates.sorted(), dates)
+    ///     }
     public var availableElements: PublisherExpectations.AvailableElements<Input, Failure> {
         PublisherExpectations.AvailableElements(recorder: self)
     }