FormData

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

FormData インターフェイスは、フォームフィールドおよびそれらの値から表現されるキーと値のペアのセットを簡単に構築する手段を提供します。これは fetch()XMLHttpRequest.send()navigator.sendBeacon() の各メソッドを用いることで送信が可能です。エンコーディング型を "multipart/form-data" に設定した場合にフォームが使用するものと同じ形式を使用します。

単純な GET の送信を用いる <form> が行うようなクエリー引数を生成したい場合は、URLSearchParams コンストラクターに直接渡すことも可能です。

FormData を実装したオブジェクトは、entries() の代わりに for...of 構造の内部で直接使用できます。for (const p of myFormData)for (const p of myFormData.entries()) と等価です。

メモ: この機能はウェブワーカーで使用できます。

コンストラクター

FormData()

新しい FormData オブジェクトを作成します。

メソッド

FormData.append()

FormData オブジェクト内の既存のキーに新たな値を追加するか、キーが存在しない場合はキーを追加します。

FormData.delete()

FormData オブジェクトからキーと値のペアを削除します。

FormData.entries()

この FormData に含まれているすべてのキーと値のペアを走査するイテレーターを返します。

FormData.get()

FormData オブジェクトの中から、指定したキーに関連付けられた最初の値を返します。

FormData.getAll()

FormData の中から、指定したキーに関連付けられたすべての値の配列を返します。

FormData.has()

FormData オブジェクトがあるキーと値のペアを持っているかを示す論理値を返します。

FormData.keys()

オブジェクト内に存在するキーと値のペアから、すべてのキーを走査できるようにするためのイテレーターを返します。

FormData.set()

FormData オブジェクト内の既存のキーに新たな値を設定するか、キーが存在しない場合はキーと値のペアを追加します。

FormData.values()

オブジェクト内に存在するキーと値のペアから、すべての値を走査できるようにするためのイテレーターを返します。

仕様書

Specification
XMLHttpRequest Standard
# interface-formdata

ブラウザーの互換性

BCD tables only load in the browser

関連情報