Skip to content

Update dom/form data #800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Aug 1, 2023
Merged

Update dom/form data #800

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3d9f133
Update FormData.scala
G-yhlee Jul 26, 2023
1f3526c
Update api-reports
G-yhlee Jul 26, 2023
31c026c
Update FormData.scala - using function overloading
G-yhlee Jul 26, 2023
3fc37fe
Update api-reports
G-yhlee Jul 26, 2023
8989d97
Add MDN documentation strings for FormData
zetashift Jul 26, 2023
60f2e98
Merge pull request #1 from scala-js/js-dom/formData
G-yhlee Jul 26, 2023
862b43e
Update FormData.scala
G-yhlee Jul 27, 2023
30cbe41
Update api-reports
G-yhlee Jul 27, 2023
aa5a898
Update FormData.scala
G-yhlee Aug 1, 2023
1582e48
Update FormData with add constructor
G-yhlee Aug 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion dom/src/main/scala/org/scalajs/dom/FormData.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,48 @@ package org.scalajs.dom

import scala.scalajs.js
import scala.scalajs.js.annotation._
import scala.scalajs.js.|

/** XMLHttpRequest Level 2 adds support for the new FormData interface. FormData objects provide a way to easily
* construct a set of key/value pairs representing form fields and their values, which can then be easily sent using
* the XMLHttpRequest send() method.
*/
@js.native
@JSGlobal
class FormData(form: HTMLFormElement = js.native) extends js.Object {
class FormData(form: HTMLFormElement = js.native) extends js.Iterable[js.Tuple2[String, String]] {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
class FormData(form: HTMLFormElement = js.native) extends js.Iterable[js.Tuple2[String, String]] {
class FormData(form: HTMLFormElement = js.native) extends js.Iterable[js.Tuple2[String, String | Blob]] {

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clear

Copy link
Member

@armanbilge armanbilge Aug 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, it seems there are three possible constructors.

new FormData()
new FormData(form)
new FormData(form, submitter)
class FormData extends ... {
  def this(form: HTMLFormElement) = this()
  def this(form: HTMLFormElement, submitter: HTMLElement) = this()
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

class FormData(form: HTMLFormElement = js.native) extends ... {
  def this(form: HTMLFormElement) = this(form)
  def this(form: HTMLFormElement, submitter: HTMLElement) = this(form)
}

I think this is good point !
I've looked at other api codes using this() and i make this code,
but I'm not sure if this change is correct.

I'd be grateful if someone could fix this part for sure

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've looked at other api codes using this() and i make this code,

That won't work, because there are two constructors that take a form. How wil it know which one to use?

I believe the correct change is the one I suggested in #800 (comment).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

got it !
I will add this part :)


/** Appends a key/value pair to the FormData object. */
def append(name: js.Any, value: js.Any, blobName: String = js.native): Unit = js.native

/** Deletes a key/value pair from the FormData object. */
def delete(name: String): Unit = js.native

/** Returns the first value associated with a given key from within a FormData object. */
def get(name: String): String | Blob = js.native

/** Returns whether a FormData object contains a certain key. */
def has(name: String): Boolean = js.native

/** Sets a new value for an existing key inside a FormData object, or adds the key/value if it does not already exist.
*/
def set(
name: String, value: String | Blob, blobName: String = js.native
): Unit = js.native

@JSName(js.Symbol.iterator)
override def jsIterator(): js.Iterator[js.Tuple2[String, String]] = js.native

/** Returns an iterator that iterates through all key/value pairs contained in the FormData. */
def entries(): js.Iterator[js.Tuple2[String, String | Blob]] = js.native

/** Returns an array of all the values associated with a given key from within a FormData. */
def getAll(name: String): js.Array[String | Blob] = js.native

/** Returns an iterator iterates through all keys of the key/value pairs contained in the FormData. */
def keys(): js.Iterator[String] = js.native

/** Returns an iterator that iterates through all values contained in the FormData. */
def values(): js.Iterator[String | Blob] = js.native
}

@js.native
Expand Down