Skip to content

Commit 4d41914

Browse files
armanbilgearmanbilge
authored
Merge pull request #617 from scala-js/topic/readyState
Revise and add `ReadyState` classes
2 parents 66e1d71 + c54097f commit 4d41914

15 files changed

+98
-44
lines changed

‎api-reports/2_12.txt

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1548,6 +1548,10 @@ DocumentFragment[JC] def removeEventListener[T <: Event](`type`: String, listene
15481548
DocumentFragment[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
15491549
DocumentFragment[JC] def replaceChild(newChild: Node, oldChild: Node): Node
15501550
DocumentFragment[JC] var textContent: String
1551+
DocumentReadyState[JT]
1552+
DocumentReadyState[SO] val complete: DocumentReadyState
1553+
DocumentReadyState[SO] val interactive: DocumentReadyState
1554+
DocumentReadyState[SO] val loading: DocumentReadyState
15511555
DocumentType[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
15521556
DocumentType[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
15531557
DocumentType[JC] def appendChild(newChild: Node): Node
@@ -4480,7 +4484,7 @@ HTMLDocument[JC] def queryCommandText(commandId: String): String
44804484
HTMLDocument[JC] def queryCommandValue(commandId: String): String
44814485
HTMLDocument[JC] def querySelector(selectors: String): Element
44824486
HTMLDocument[JC] def querySelectorAll(selectors: String): NodeList[Element]
4483-
HTMLDocument[JC] def readyState: String
4487+
HTMLDocument[JC] def readyState: DocumentReadyState
44844488
HTMLDocument[JC] def referrer: String
44854489
HTMLDocument[JC] def removeChild(oldChild: Node): Node
44864490
HTMLDocument[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
@@ -14093,7 +14097,7 @@ IDBOpenDBRequest[JC] var onblocked: js.Function1[IDBVersionChangeEvent, _]
1409314097
IDBOpenDBRequest[JC] var onerror: js.Function1[Event, _]
1409414098
IDBOpenDBRequest[JC] var onsuccess: js.Function1[IDBEvent[A], _]
1409514099
IDBOpenDBRequest[JC] var onupgradeneeded: js.Function1[IDBVersionChangeEvent, _]
14096-
IDBOpenDBRequest[JC] def readyState: String
14100+
IDBOpenDBRequest[JC] def readyState: IDBRequestReadyState
1409714101
IDBOpenDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
1409814102
IDBOpenDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
1409914103
IDBOpenDBRequest[JC] def result: A
@@ -14105,12 +14109,15 @@ IDBRequest[JC] def dispatchEvent(evt: Event): Boolean
1410514109
IDBRequest[JC] def error: DOMException
1410614110
IDBRequest[JC] var onerror: js.Function1[Event, _]
1410714111
IDBRequest[JC] var onsuccess: js.Function1[IDBEvent[A], _]
14108-
IDBRequest[JC] def readyState: String
14112+
IDBRequest[JC] def readyState: IDBRequestReadyState
1410914113
IDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
1411014114
IDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
1411114115
IDBRequest[JC] def result: A
1411214116
IDBRequest[JC] def source: S
1411314117
IDBRequest[JC] def transaction: IDBTransaction
14118+
IDBRequestReadyState[JT]
14119+
IDBRequestReadyState[SO] val done: IDBRequestReadyState
14120+
IDBRequestReadyState[SO] val pending: IDBRequestReadyState
1411414121
IDBStoreLike[JT] def count(query: IDBKey | IDBKeyRange?): IDBRequest[S, Double]
1411514122
IDBStoreLike[JT] def get(key: IDBKey | IDBKeyRange): IDBRequest[S, IDBValue]
1411614123
IDBStoreLike[JT] def getAll(query: js.UndefOr[IDBKeyRange | IDBKey]?, count: js.UndefOr[Double]?): IDBRequest[S, js.Array[IDBValue]]
@@ -14761,13 +14768,17 @@ MediaSource[JC] def endOfStream(error: EndOfStreamError?): Unit
1476114768
MediaSource[JC] var onsourceclose: js.Function1[Event, Any]
1476214769
MediaSource[JC] var onsourceended: js.Function1[Event, Any]
1476314770
MediaSource[JC] var onsourceopen: js.Function1[Event, Any]
14764-
MediaSource[JC] def readyState: ReadyState
14771+
MediaSource[JC] def readyState: MediaSourceReadyState
1476514772
MediaSource[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
1476614773
MediaSource[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
1476714774
MediaSource[JC] def removeSourceBuffer(sourceBuffer: SourceBuffer): Unit
1476814775
MediaSource[JC] def setLiveSeekableRange(start: Double, end: Double): Unit
1476914776
MediaSource[JC] def sourceBuffers: SourceBufferList
1477014777
MediaSource[JO] def isTypeSupported(mediaType: String): Boolean
14778+
MediaSourceReadyState[JT]
14779+
MediaSourceReadyState[SO] val closed: MediaSourceReadyState
14780+
MediaSourceReadyState[SO] val ended: MediaSourceReadyState
14781+
MediaSourceReadyState[SO] val open: MediaSourceReadyState
1477114782
MediaStream[JC] val active: Boolean
1477214783
MediaStream[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
1477314784
MediaStream[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
@@ -15845,10 +15856,6 @@ ReadableStreamReader[JC] def cancel(reason: Any): js.Promise[Any]
1584515856
ReadableStreamReader[JC] def closed: js.Promise[ReadableStreamReader[T]]
1584615857
ReadableStreamReader[JC] def read(): js.Promise[Chunk[T]]
1584715858
ReadableStreamReader[JC] def releaseLock(): Unit
15848-
ReadyState[JT]
15849-
ReadyState[SO] val closed: ReadyState
15850-
ReadyState[SO] val ended: ReadyState
15851-
ReadyState[SO] val open: ReadyState
1585215859
ReferrerPolicy[JT]
1585315860
ReferrerPolicy[SO] val empty: ReferrerPolicy
1585415861
ReferrerPolicy[SO] val `no-referrer` = "no-referrer".asInstanceOf[ReferrerPolicy]
@@ -25559,7 +25566,7 @@ experimental/mediastream/package[SO] type MediaTrackConstraintSet = dom.MediaTra
2555925566
experimental/mediastream/package[SO] type MediaTrackConstraints = dom.MediaTrackConstraints (@deprecated in 2.0.0)
2556025567
experimental/mediastream/package[SO] type MediaTrackSettings = dom.MediaTrackSettings (@deprecated in 2.0.0)
2556125568
experimental/mediastream/package[SO] type MediaTrackSupportedConstraints = dom.MediaTrackSupportedConstraints (@deprecated in 2.0.0)
25562-
experimental/mediastream/package[SO] type ReadyState = dom.ReadyState (@deprecated in 2.0.0)
25569+
experimental/mediastream/package[SO] type ReadyState = dom.MediaSourceReadyState (@deprecated in 2.0.0)
2556325570
experimental/mediastream/package[SO] type SourceBuffer = dom.SourceBuffer (@deprecated in 2.0.0)
2556425571
experimental/mediastream/package[SO] type SourceBufferList = dom.SourceBufferList (@deprecated in 2.0.0)
2556525572
experimental/mediastream/package[SO] type TextTrack = dom.TextTrack (@deprecated in 2.0.0)

‎api-reports/2_13.txt

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1548,6 +1548,10 @@ DocumentFragment[JC] def removeEventListener[T <: Event](`type`: String, listene
15481548
DocumentFragment[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
15491549
DocumentFragment[JC] def replaceChild(newChild: Node, oldChild: Node): Node
15501550
DocumentFragment[JC] var textContent: String
1551+
DocumentReadyState[JT]
1552+
DocumentReadyState[SO] val complete: DocumentReadyState
1553+
DocumentReadyState[SO] val interactive: DocumentReadyState
1554+
DocumentReadyState[SO] val loading: DocumentReadyState
15511555
DocumentType[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
15521556
DocumentType[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
15531557
DocumentType[JC] def appendChild(newChild: Node): Node
@@ -4480,7 +4484,7 @@ HTMLDocument[JC] def queryCommandText(commandId: String): String
44804484
HTMLDocument[JC] def queryCommandValue(commandId: String): String
44814485
HTMLDocument[JC] def querySelector(selectors: String): Element
44824486
HTMLDocument[JC] def querySelectorAll(selectors: String): NodeList[Element]
4483-
HTMLDocument[JC] def readyState: String
4487+
HTMLDocument[JC] def readyState: DocumentReadyState
44844488
HTMLDocument[JC] def referrer: String
44854489
HTMLDocument[JC] def removeChild(oldChild: Node): Node
44864490
HTMLDocument[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
@@ -14093,7 +14097,7 @@ IDBOpenDBRequest[JC] var onblocked: js.Function1[IDBVersionChangeEvent, _]
1409314097
IDBOpenDBRequest[JC] var onerror: js.Function1[Event, _]
1409414098
IDBOpenDBRequest[JC] var onsuccess: js.Function1[IDBEvent[A], _]
1409514099
IDBOpenDBRequest[JC] var onupgradeneeded: js.Function1[IDBVersionChangeEvent, _]
14096-
IDBOpenDBRequest[JC] def readyState: String
14100+
IDBOpenDBRequest[JC] def readyState: IDBRequestReadyState
1409714101
IDBOpenDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
1409814102
IDBOpenDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
1409914103
IDBOpenDBRequest[JC] def result: A
@@ -14105,12 +14109,15 @@ IDBRequest[JC] def dispatchEvent(evt: Event): Boolean
1410514109
IDBRequest[JC] def error: DOMException
1410614110
IDBRequest[JC] var onerror: js.Function1[Event, _]
1410714111
IDBRequest[JC] var onsuccess: js.Function1[IDBEvent[A], _]
14108-
IDBRequest[JC] def readyState: String
14112+
IDBRequest[JC] def readyState: IDBRequestReadyState
1410914113
IDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
1411014114
IDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
1411114115
IDBRequest[JC] def result: A
1411214116
IDBRequest[JC] def source: S
1411314117
IDBRequest[JC] def transaction: IDBTransaction
14118+
IDBRequestReadyState[JT]
14119+
IDBRequestReadyState[SO] val done: IDBRequestReadyState
14120+
IDBRequestReadyState[SO] val pending: IDBRequestReadyState
1411414121
IDBStoreLike[JT] def count(query: IDBKey | IDBKeyRange?): IDBRequest[S, Double]
1411514122
IDBStoreLike[JT] def get(key: IDBKey | IDBKeyRange): IDBRequest[S, IDBValue]
1411614123
IDBStoreLike[JT] def getAll(query: js.UndefOr[IDBKeyRange | IDBKey]?, count: js.UndefOr[Double]?): IDBRequest[S, js.Array[IDBValue]]
@@ -14761,13 +14768,17 @@ MediaSource[JC] def endOfStream(error: EndOfStreamError?): Unit
1476114768
MediaSource[JC] var onsourceclose: js.Function1[Event, Any]
1476214769
MediaSource[JC] var onsourceended: js.Function1[Event, Any]
1476314770
MediaSource[JC] var onsourceopen: js.Function1[Event, Any]
14764-
MediaSource[JC] def readyState: ReadyState
14771+
MediaSource[JC] def readyState: MediaSourceReadyState
1476514772
MediaSource[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
1476614773
MediaSource[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
1476714774
MediaSource[JC] def removeSourceBuffer(sourceBuffer: SourceBuffer): Unit
1476814775
MediaSource[JC] def setLiveSeekableRange(start: Double, end: Double): Unit
1476914776
MediaSource[JC] def sourceBuffers: SourceBufferList
1477014777
MediaSource[JO] def isTypeSupported(mediaType: String): Boolean
14778+
MediaSourceReadyState[JT]
14779+
MediaSourceReadyState[SO] val closed: MediaSourceReadyState
14780+
MediaSourceReadyState[SO] val ended: MediaSourceReadyState
14781+
MediaSourceReadyState[SO] val open: MediaSourceReadyState
1477114782
MediaStream[JC] val active: Boolean
1477214783
MediaStream[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
1477314784
MediaStream[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
@@ -15845,10 +15856,6 @@ ReadableStreamReader[JC] def cancel(reason: Any): js.Promise[Any]
1584515856
ReadableStreamReader[JC] def closed: js.Promise[ReadableStreamReader[T]]
1584615857
ReadableStreamReader[JC] def read(): js.Promise[Chunk[T]]
1584715858
ReadableStreamReader[JC] def releaseLock(): Unit
15848-
ReadyState[JT]
15849-
ReadyState[SO] val closed: ReadyState
15850-
ReadyState[SO] val ended: ReadyState
15851-
ReadyState[SO] val open: ReadyState
1585215859
ReferrerPolicy[JT]
1585315860
ReferrerPolicy[SO] val empty: ReferrerPolicy
1585415861
ReferrerPolicy[SO] val `no-referrer` = "no-referrer".asInstanceOf[ReferrerPolicy]
@@ -25559,7 +25566,7 @@ experimental/mediastream/package[SO] type MediaTrackConstraintSet = dom.MediaTra
2555925566
experimental/mediastream/package[SO] type MediaTrackConstraints = dom.MediaTrackConstraints (@deprecated in 2.0.0)
2556025567
experimental/mediastream/package[SO] type MediaTrackSettings = dom.MediaTrackSettings (@deprecated in 2.0.0)
2556125568
experimental/mediastream/package[SO] type MediaTrackSupportedConstraints = dom.MediaTrackSupportedConstraints (@deprecated in 2.0.0)
25562-
experimental/mediastream/package[SO] type ReadyState = dom.ReadyState (@deprecated in 2.0.0)
25569+
experimental/mediastream/package[SO] type ReadyState = dom.MediaSourceReadyState (@deprecated in 2.0.0)
2556325570
experimental/mediastream/package[SO] type SourceBuffer = dom.SourceBuffer (@deprecated in 2.0.0)
2556425571
experimental/mediastream/package[SO] type SourceBufferList = dom.SourceBufferList (@deprecated in 2.0.0)
2556525572
experimental/mediastream/package[SO] type TextTrack = dom.TextTrack (@deprecated in 2.0.0)

‎dom/src/main/scala-2/org/scalajs/dom/DocumentReadyState.scala

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
@js.native
6+
sealed trait DocumentReadyState extends js.Any
7+
8+
object DocumentReadyState {
9+
val complete: DocumentReadyState = "complete".asInstanceOf[DocumentReadyState]
10+
val interactive: DocumentReadyState = "interactive".asInstanceOf[DocumentReadyState]
11+
val loading: DocumentReadyState = "loading".asInstanceOf[DocumentReadyState]
12+
}

‎dom/src/main/scala-2/org/scalajs/dom/IDBRequestReadyState.scala

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
@js.native
6+
sealed trait IDBRequestReadyState extends js.Any
7+
8+
object IDBRequestReadyState {
9+
val done: IDBRequestReadyState = "done".asInstanceOf[IDBRequestReadyState]
10+
val pending: IDBRequestReadyState = "pending".asInstanceOf[IDBRequestReadyState]
11+
}

‎dom/src/main/scala-2/org/scalajs/dom/MediaSourceReadyState.scala

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
@js.native
6+
sealed trait MediaSourceReadyState extends js.Any
7+
8+
object MediaSourceReadyState {
9+
val closed: MediaSourceReadyState = "closed".asInstanceOf[MediaSourceReadyState]
10+
val ended: MediaSourceReadyState = "ended".asInstanceOf[MediaSourceReadyState]
11+
val open: MediaSourceReadyState = "open".asInstanceOf[MediaSourceReadyState]
12+
}

‎dom/src/main/scala-2/org/scalajs/dom/ReadyState.scala

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎dom/src/main/scala-3/org/scalajs/dom/DocumentReadyState.scala

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
package org.scalajs.dom
2+
3+
opaque type DocumentReadyState <: String = String
4+
5+
object DocumentReadyState {
6+
val complete: DocumentReadyState = "complete"
7+
val interactive: DocumentReadyState = "interactive"
8+
val loading: DocumentReadyState = "loading"
9+
}

‎dom/src/main/scala-3/org/scalajs/dom/IDBRequestReadyState.scala

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
package org.scalajs.dom
2+
3+
opaque type IDBRequestReadyState <: String = String
4+
5+
object IDBRequestReadyState {
6+
val done: IDBRequestReadyState = "done"
7+
val pending: IDBRequestReadyState = "pending"
8+
}

‎dom/src/main/scala-3/org/scalajs/dom/MediaSourceReadyState.scala

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
package org.scalajs.dom
2+
3+
opaque type MediaSourceReadyState <: String = String
4+
5+
object MediaSourceReadyState {
6+
val closed: MediaSourceReadyState = "closed"
7+
val ended: MediaSourceReadyState = "ended"
8+
val open: MediaSourceReadyState = "open"
9+
}

‎dom/src/main/scala-3/org/scalajs/dom/ReadyState.scala

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎dom/src/main/scala/org/scalajs/dom/HTMLDocument.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ abstract class HTMLDocument extends Document {
4747
/** Returns "loading" while the document is loading, "interactive" once it is finished parsing but still loading
4848
* sub-resources, and "complete" once it has loaded.
4949
*/
50-
def readyState: String = js.native
50+
def readyState: DocumentReadyState = js.native
5151

5252
var uniqueID: String = js.native
5353

‎dom/src/main/scala/org/scalajs/dom/IDBRequest.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ class IDBRequest[+S, A] extends EventTarget {
4646
/** The state of the request. Every request starts in the pending state. The state changes to done when the request
4747
* completes successfully or when an error occurs.
4848
*/
49-
def readyState: String = js.native
49+
def readyState: IDBRequestReadyState = js.native
5050

5151
/** Returns the result of the request. If the the request failed and the result is not available,
5252
* the InvalidStateError exception is thrown.

‎dom/src/main/scala/org/scalajs/dom/MediaSource.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import scala.scalajs.js.annotation._
1313
class MediaSource extends EventTarget {
1414
def sourceBuffers: SourceBufferList = js.native
1515
def activeSourceBuffers: SourceBufferList = js.native
16-
def readyState: ReadyState = js.native
16+
def readyState: MediaSourceReadyState = js.native
1717

1818
/** Allows the web application to set the presentation duration.
1919
*

‎dom/src/main/scala/org/scalajs/dom/experimental/mediastream/package.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ package object mediastream {
1616
@deprecated("use dom.EndOfStreamError instead", "2.0.0")
1717
type EndOfStreamError = dom.EndOfStreamError
1818

19-
@deprecated("use dom.ReadyState instead", "2.0.0")
20-
type ReadyState = dom.ReadyState
19+
@deprecated("use dom.MediaSourceReadyState instead", "2.0.0")
20+
type ReadyState = dom.MediaSourceReadyState
2121

2222
@deprecated("use dom.AudioTrack instead", "2.0.0")
2323
type AudioTrack = dom.AudioTrack

‎dom/src/main/scala/org/scalajs/dom/webgl/webgl.scala renamed to ‎dom/src/main/scala/org/scalajs/dom/webgl/package.scala

File renamed without changes.

0 commit comments

Comments
 (0)