FileSystemWritableFileStream.write()
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
FileSystemWritableFileStream
インターフェイスの write()
メソッドは、このメソッドが呼ばれたファイルの現在のファイルカーソルオフセットにデータを書き込みます。
ストリームを閉じるまで、変更は実際のファイルには一切書き込まれません。 通常、変更はかわりに一時ファイルに書き込まれます。このメソッドは、ストリーム内で書き込む位置を移動したり、ファイルを切り詰めてファイル全体のバイト数を変更したりすることにも使用できます。
構文
write(data)
引数
data
-
ファイルに書き込むデータを表す
ArrayBuffer
・TypedArray
・DataView
・Blob
・String
オブジェクト・文字列リテラルのいずれかです。 もしくは、以下のプロパティを持つオブジェクトです。type
-
"write"
・"seek"
・"truncate"
のいずれかの文字列です。 data
-
ファイルに書き込むデータです。
ArrayBuffer
・TypedArray
・DataView
・Blob
・String
オブジェクト・文字列リテラルのいずれかです。type
がwrite
に設定されているときは必須です。 position
-
type
がseek
のとき、現在のファイルカーソルの移動先のバイト位置を表します。type
がwrite
のときにも設定することができ、この場合は書き込みの開始位置を表します。 size
-
ストリームが保持するべきバイト数を表す
unsigned long
値です。type
がtruncate
に設定されているときは必須です。
返値
undefined
で解決する Promise
を返します。
例外
NotAllowedError
DOMException
-
PermissionStatus
がgranted
でないとき返されます。 TypeError
-
data
がundefined
であるか、position
またはsize
が無効な値のとき返されます。 InvalidStateError
DOMException
-
position
が存在するバイト数より大きい値に設定されているとき返されます。
例
この非同期関数は「Save File」ピッカーを開きます。このピッカーは、ファイルが選択されると FileSystemFileHandle
を返します。
このハンドルから、FileSystemFileHandle.createWritable()
メソッドを用いて書き込み可能なストリームを作成します。
そして、ユーザーが指定した Blob
がストリームに書き込まれ、ストリームが閉じられます。
async function saveFile() {
// 新しいハンドルを作成する
const newHandle = await window.showSaveFilePicker();
// 書き込み先の FileSystemWritableFileStream を作成する
const writableStream = await newHandle.createWritable();
// ファイルに書き込む
await writableStream.write(imgBlob);
// ファイルを閉じ、データをディスクに書き込む
await writableStream.close();
}
以下では、write()
メソッドに渡すことができる異なるオプションの例を示します。
// データだけを渡す (オプションなし)
writableStream.write(data);
// ストリームに指定の位置からデータを書き込む
writableStream.write({ type: "write", position, data });
// 現在のファイルカーソルオフセットを指定の位置に移動する
writableStream.write({ type: "seek", position });
// ファイルを size バイトにする
writableStream.write({ type: "truncate", size });
仕様書
Specification |
---|
File System Standard # api-filesystemwritablefilestream-write |
ブラウザーの互換性
BCD tables only load in the browser