Skip to content

Commit 5d11d2c

Browse files
committed
Fix scaladoc for ReadableStreamReader.cancel overloads.
1 parent d3b38ed commit 5d11d2c

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

dom/src/main/scala/org/scalajs/dom/ReadableStreamUnderlyingSource.scala

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,11 @@ trait ReadableStreamUnderlyingSource[T] extends js.Object {
3434
var pull: js.UndefOr[js.Function1[ReadableStreamController[T], Unit | js.Promise[Unit]]] = js.undefined
3535

3636
/** A function that is called whenever the consumer cancels the stream, via [[ReadableStream.cancel]] or
37-
* [[ReadableStreamReader.cancel]]. It takes as its argument the same value as was passed to those methods by the
38-
* consumer.
39-
*
40-
* If the shutdown process is asynchronous, it can return a promise to signal success or failure; the result will be
41-
* communicated via the return value of the [[cancel]] method that was called. Additionally, a rejected promise will
42-
* error the stream, instead of letting it close. Throwing an exception is treated the same as returning a rejected
43-
* promise.
37+
* [[ReadableStreamReader.cancel():scala\.scalajs\.js\.Promise[Unit]*]]. It takes as its argument the same value as
38+
* was passed to those methods by the consumer. If the shutdown process is asynchronous, it can return a promise to
39+
* signal success or failure; the result will be communicated via the return value of the [[cancel]] method that was
40+
* called. Additionally, a rejected promise will error the stream, instead of letting it close. Throwing an exception
41+
* is treated the same as returning a rejected promise.
4442
*/
4543
var cancel: js.UndefOr[js.Function1[js.Any, Unit | js.Promise[Unit]]] = js.undefined
4644

0 commit comments

Comments
 (0)