Skip to content

Commit 5411cf0

Browse files
committed
Make reason for Stream abort/cancel optional
1 parent d912d9f commit 5411cf0

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

api-reports/2_12.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ experimental/PointerLock.PointerLockDocument[JT] def pointerLockElement: Element
320320
experimental/PointerLock.PointerLockElement[JT] def requestPointerLock(): Unit
321321
experimental/PointerLock.PointerLockMouseEvent[JT] def movementX: Double
322322
experimental/PointerLock.PointerLockMouseEvent[JT] def movementY: Double
323-
experimental/ReadableStream[JT] def cancel(reason: String): js.Promise[Any]
323+
experimental/ReadableStream[JT] def cancel(reason: js.UndefOr[Any] = js.undefined): js.Promise[Unit]
324324
experimental/ReadableStream[JT] def getReader(): ReadableStreamReader[T]
325325
experimental/ReadableStream[JT] def locked: Boolean
326326
experimental/ReadableStream[JT] def pipeThrough[U](pair: Any, options: Any = js.undefined): ReadableStream[U]
@@ -469,7 +469,7 @@ experimental/WriteableState[SO] val closing = "closing".asInstanceOf[WriteableSt
469469
experimental/WriteableState[SO] val errored = "errored".asInstanceOf[WriteableState]
470470
experimental/WriteableState[SO] val waiting = "waiting".asInstanceOf[WriteableState]
471471
experimental/WriteableState[SO] val writable = "writable".asInstanceOf[WriteableState]
472-
experimental/WriteableStream[JT] def abort(reason: Any): Unit
472+
experimental/WriteableStream[JT] def abort(reason: js.UndefOr[Any] = js.undefined): js.Promise[Unit]
473473
experimental/WriteableStream[JT] def close(): js.Promise[WriteableStream[T]]
474474
experimental/WriteableStream[JT] val closed: js.Promise[WriteableStream[T]]
475475
experimental/WriteableStream[JT] val ready: js.Promise[WriteableStream[T]]

api-reports/2_13.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ experimental/PointerLock.PointerLockDocument[JT] def pointerLockElement: Element
320320
experimental/PointerLock.PointerLockElement[JT] def requestPointerLock(): Unit
321321
experimental/PointerLock.PointerLockMouseEvent[JT] def movementX: Double
322322
experimental/PointerLock.PointerLockMouseEvent[JT] def movementY: Double
323-
experimental/ReadableStream[JT] def cancel(reason: String): js.Promise[Any]
323+
experimental/ReadableStream[JT] def cancel(reason: js.UndefOr[Any] = js.undefined): js.Promise[Unit]
324324
experimental/ReadableStream[JT] def getReader(): ReadableStreamReader[T]
325325
experimental/ReadableStream[JT] def locked: Boolean
326326
experimental/ReadableStream[JT] def pipeThrough[U](pair: Any, options: Any = js.undefined): ReadableStream[U]
@@ -469,7 +469,7 @@ experimental/WriteableState[SO] val closing = "closing".asInstanceOf[WriteableSt
469469
experimental/WriteableState[SO] val errored = "errored".asInstanceOf[WriteableState]
470470
experimental/WriteableState[SO] val waiting = "waiting".asInstanceOf[WriteableState]
471471
experimental/WriteableState[SO] val writable = "writable".asInstanceOf[WriteableState]
472-
experimental/WriteableStream[JT] def abort(reason: Any): Unit
472+
experimental/WriteableStream[JT] def abort(reason: js.UndefOr[Any] = js.undefined): js.Promise[Unit]
473473
experimental/WriteableStream[JT] def close(): js.Promise[WriteableStream[T]]
474474
experimental/WriteableStream[JT] val closed: js.Promise[WriteableStream[T]]
475475
experimental/WriteableStream[JT] val ready: js.Promise[WriteableStream[T]]

src/main/scala/org/scalajs/dom/experimental/Stream.scala

+7-5
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,10 @@ trait WriteableStream[-T] extends js.Object {
8787
* abort mechanism of the underlying sink.
8888
* see [[https://streams.spec.whatwg.org/#ws-abort ¶4.2.4.4. abort(reason)]]
8989
*
90-
* @param reason spec specifies Any (!?)
90+
* @param reason
9191
*/
92-
def abort(reason: Any): Unit = js.native
92+
def abort(s
93+
reason: js.UndefOr[Any] = js.undefined): js.Promise[Unit] = js.native
9394

9495
/**
9596
* The close method signals that the producer is done writing chunks to the
@@ -148,10 +149,11 @@ trait ReadableStream[+T] extends js.Object {
148149
* the stream by a consumer. The supplied reason argument will be given to
149150
* the underlying source, which may or may not use it.
150151
*
151-
* @param reason the reason <- actually not what type this is
152-
* @return a Promise, but not quite sure what it can contain
152+
* @param reason the reason
153+
* @return a Promise
153154
*/
154-
def cancel(reason: String): js.Promise[Any] = js.native
155+
def cancel(
156+
reason: js.UndefOr[Any] = js.undefined): js.Promise[Unit] = js.native
155157

156158
/**
157159
* See [[https://streams.spec.whatwg.org/#rs-get-reader ¶3.2.4.3. getReader()]]

0 commit comments

Comments
 (0)