FileSystemWritableFileStream: write()-Methode
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.
Hinweis: Dieses Feature ist verfügbar in Web Workers.
Die write()
-Methode des FileSystemWritableFileStream
-Interfaces schreibt Inhalte in die Datei, auf die die Methode aufgerufen wird, an der aktuellen Datei-Cursor-Position.
Es werden keine Änderungen in die eigentliche Datei auf der Festplatte geschrieben, bis der Stream geschlossen wurde. Änderungen werden in der Regel stattdessen in eine temporäre Datei geschrieben. Diese Methode kann auch verwendet werden, um zu einem bestimmten Bytepunkt innerhalb des Streams zu suchen und zu kürzen, um die Gesamtanzahl der Bytes in der Datei zu ändern.
Syntax
write(data)
Parameter
data
-
Kann eines der folgenden sein:
-
Die zu schreibenden Dateidaten in Form eines
ArrayBuffer
,TypedArray
,DataView
,Blob
oder Strings. -
Ein Objekt, das die folgenden Eigenschaften enthält:
type
-
Ein String, der einer der folgenden ist:
"write"
,"seek"
oder"truncate"
. data
-
Die zu schreibenden Dateidaten. Kann ein
ArrayBuffer
,TypedArray
,DataView
,Blob
oder ein String sein. Diese Eigenschaft ist erforderlich, wenntype
auf"write"
gesetzt ist. position
-
Die Byte-Position, zu der der aktuelle Datei-Cursor wechseln soll, wenn der Typ
"seek"
verwendet wird. Kann auch gesetzt werden, wenntype
"write"
ist, wobei das Schreiben an der angegebenen Position beginnt. size
-
Eine Zahl, die die Anzahl der Bytes darstellt, die der Stream enthalten soll. Diese Eigenschaft ist erforderlich, wenn
type
auf"truncate"
gesetzt ist.
-
Rückgabewert
Ein Promise
der undefined
zurückgibt.
Ausnahmen
NotAllowedError
DOMException
-
Wird ausgelöst, wenn
PermissionStatus.state
nichtgranted
ist. QuotaExceededError
DOMException
-
Wird ausgelöst, wenn die neue Größe der Datei größer als die ursprüngliche Größe der Datei ist und das Speicher-Limit des Browsers überschreitet.
TypeError
-
Wird ausgelöst, wenn
data
undefiniert ist oderposition
odersize
nicht gültig sind.
Beispiele
Die folgende asynchrone Funktion öffnet den 'Datei speichern'-Dialog, der einen FileSystemFileHandle
zurückgibt, sobald eine Datei ausgewählt wurde. Daraus wird ein beschreibbarer Stream mithilfe der FileSystemFileHandle.createWritable()
-Methode erstellt.
Ein Textstring wird dann in den Stream geschrieben, der anschließend geschlossen wird.
async function saveFile() {
try {
// create a new handle
const newHandle = await window.showSaveFilePicker();
// create a FileSystemWritableFileStream to write to
const writableStream = await newHandle.createWritable();
// write our file
await writableStream.write("This is my file content");
// close the file and write the contents to disk.
await writableStream.close();
} catch (err) {
console.error(err.name, err.message);
}
}
Die folgenden Beispiele zeigen verschiedene Optionen, die in die write()
-Methode übergeben werden können.
// just pass in the data (no options)
writableStream.write(data);
// writes the data to the stream from the determined position
writableStream.write({ type: "write", position, data });
// updates the current file cursor offset to the position specified
writableStream.write({ type: "seek", position });
// resizes the file to be size bytes long
writableStream.write({ type: "truncate", size });
Spezifikationen
Specification |
---|
File System Standard # api-filesystemwritablefilestream-write |
Browser-Kompatibilität
BCD tables only load in the browser