kotlin-web/web.form/FormData

FormData

open class FormData(form: EventTarget = definedExternally, submitter: EventTarget? = definedExternally) : MapLike<JsString, FormDataEntryValue> (source)

The FormData interface provides a way to construct a set of key/value pairs representing form fields and their values, which can be sent using the fetch(), XMLHttpRequest.send() or navigator.sendBeacon() methods. It uses the same format a form would use if the encoding type were set to "multipart/form-data".

MDN Reference

Constructors

FormData

constructor(form: EventTarget = definedExternally, submitter: EventTarget? = definedExternally)

Functions

append

fun append(name: String, value: String)

The append() method of the FormData interface appends a new value onto an existing key inside a FormData object, or adds the key if it does not already exist.

fun append(name: String, value: Blob)

fun append(name: String, blobValue: Blob, filename: String = definedExternally)

delete

fun delete(name: String)

The delete() method of the FormData interface deletes a key and its value(s) from a FormData object.

entries

open override fun entries(): JsIterator<Tuple2<JsString, FormDataEntryValue>>

forEach

open override fun forEach(action: (FormDataEntryValue, key: JsString) -> Unit)

get

open operator fun get(key: Symbol.iterator): () -> JsIterator<Tuple2<JsString, FormDataEntryValue>>

fun get(name: String): FormDataEntryValue?

The get() method of the FormData interface returns the first value associated with a given key from within a FormData object. If you expect multiple values and want all of them, use the getAll() method instead.

getAll

fun getAll(name: String): ReadonlyArray<FormDataEntryValue>

The getAll() method of the FormData interface returns all the values associated with a given key from within a FormData object.

has

fun has(name: String): Boolean

The has() method of the FormData interface returns whether a FormData object contains a certain key.

keys

open override fun keys(): JsIterator<JsString>

set

fun set(name: String, value: String)

The set() method of the FormData interface sets a new value for an existing key inside a FormData object, or adds the key/value if it does not already exist.

fun set(name: String, value: Blob)

fun set(name: String, blobValue: Blob, filename: String = definedExternally)

values

open override fun values(): JsIterator<FormDataEntryValue>