From ef6b16cbc5cd0731025a003faec0241d20465b98 Mon Sep 17 00:00:00 2001 From: David Barri Date: Wed, 20 Oct 2021 10:57:03 +1100 Subject: [PATCH 1/2] Clarify why the AJAX helpers are deprecated --- src/main/scala/org/scalajs/dom/ext/Ajax.scala | 2 +- src/main/scala/org/scalajs/dom/ext/AjaxException.scala | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/scala/org/scalajs/dom/ext/Ajax.scala b/src/main/scala/org/scalajs/dom/ext/Ajax.scala index c2937c21d..5c756bd3b 100644 --- a/src/main/scala/org/scalajs/dom/ext/Ajax.scala +++ b/src/main/scala/org/scalajs/dom/ext/Ajax.scala @@ -10,7 +10,7 @@ import scala.scalajs.js.typedarray.ArrayBufferView import scala.scalajs.js.typedarray.TypedArrayBufferOps._ /** Wraps an XMLHttpRequest to provide an easy one-line way of making an Ajax call, returning a Future. */ -@deprecated("use the dom.fetch API instead", "2.0.0") +@deprecated("scalajs-dom no longer includes custom utilities, only facades. Try using dom.fetch API which doesn't require additional utilities.", "2.0.0") object Ajax { /** Supported data formats for Ajax are implicitly converted to InputData */ diff --git a/src/main/scala/org/scalajs/dom/ext/AjaxException.scala b/src/main/scala/org/scalajs/dom/ext/AjaxException.scala index da56f64cd..e7b87864c 100644 --- a/src/main/scala/org/scalajs/dom/ext/AjaxException.scala +++ b/src/main/scala/org/scalajs/dom/ext/AjaxException.scala @@ -5,11 +5,11 @@ import org.scalajs.dom /** Thrown when `Ajax.get` or `Ajax.post` receives a non-20X response code. Contains the XMLHttpRequest that resulted in * that response */ -@deprecated("use the dom.fetch API instead", "2.0.0") +@deprecated("scalajs-dom no longer includes custom utilities, only facades. Try using dom.fetch API which doesn't require additional utilities.", "2.0.0") case class AjaxException(xhr: dom.XMLHttpRequest) extends Exception { def isTimeout: Boolean = xhr.status == 0 && xhr.readyState == 4 } // This is just there to work around some weird warnings in Scala 3.x -@deprecated("use the dom.fetch API instead", "2.0.0") +@deprecated("scalajs-dom no longer includes custom utilities, only facades. Try using dom.fetch API which doesn't require additional utilities.", "2.0.0") object AjaxException extends (dom.XMLHttpRequest => AjaxException) From 9636689b8c23d16f7d3bd83f761bccefc3729930 Mon Sep 17 00:00:00 2001 From: Arman Bilge Date: Wed, 20 Oct 2021 02:28:12 +0000 Subject: [PATCH 2/2] Formatting --- src/main/scala/org/scalajs/dom/ext/Ajax.scala | 4 +++- src/main/scala/org/scalajs/dom/ext/AjaxException.scala | 8 ++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/main/scala/org/scalajs/dom/ext/Ajax.scala b/src/main/scala/org/scalajs/dom/ext/Ajax.scala index 5c756bd3b..97140cd40 100644 --- a/src/main/scala/org/scalajs/dom/ext/Ajax.scala +++ b/src/main/scala/org/scalajs/dom/ext/Ajax.scala @@ -10,7 +10,9 @@ import scala.scalajs.js.typedarray.ArrayBufferView import scala.scalajs.js.typedarray.TypedArrayBufferOps._ /** Wraps an XMLHttpRequest to provide an easy one-line way of making an Ajax call, returning a Future. */ -@deprecated("scalajs-dom no longer includes custom utilities, only facades. Try using dom.fetch API which doesn't require additional utilities.", "2.0.0") +@deprecated( + "scalajs-dom no longer includes custom utilities, only facades. Try using dom.fetch API which doesn't require additional utilities.", + "2.0.0") object Ajax { /** Supported data formats for Ajax are implicitly converted to InputData */ diff --git a/src/main/scala/org/scalajs/dom/ext/AjaxException.scala b/src/main/scala/org/scalajs/dom/ext/AjaxException.scala index e7b87864c..6f58daae0 100644 --- a/src/main/scala/org/scalajs/dom/ext/AjaxException.scala +++ b/src/main/scala/org/scalajs/dom/ext/AjaxException.scala @@ -5,11 +5,15 @@ import org.scalajs.dom /** Thrown when `Ajax.get` or `Ajax.post` receives a non-20X response code. Contains the XMLHttpRequest that resulted in * that response */ -@deprecated("scalajs-dom no longer includes custom utilities, only facades. Try using dom.fetch API which doesn't require additional utilities.", "2.0.0") +@deprecated( + "scalajs-dom no longer includes custom utilities, only facades. Try using dom.fetch API which doesn't require additional utilities.", + "2.0.0") case class AjaxException(xhr: dom.XMLHttpRequest) extends Exception { def isTimeout: Boolean = xhr.status == 0 && xhr.readyState == 4 } // This is just there to work around some weird warnings in Scala 3.x -@deprecated("scalajs-dom no longer includes custom utilities, only facades. Try using dom.fetch API which doesn't require additional utilities.", "2.0.0") +@deprecated( + "scalajs-dom no longer includes custom utilities, only facades. Try using dom.fetch API which doesn't require additional utilities.", + "2.0.0") object AjaxException extends (dom.XMLHttpRequest => AjaxException)