FileSystemWritableFileStream: write() method
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Web Workers.
The write()
method of the FileSystemWritableFileStream
interface writes content into the file the method is called on, at the current file cursor offset.
No changes are written to the actual file on disk until the stream has been closed. Changes are typically written to a temporary file instead. This method can also be used to seek to a byte point within the stream and truncate to modify the total bytes the file contains.
Syntax
write(data)
Parameters
data
-
Can be one of the following:
- The file data to write, in the form of an
ArrayBuffer
,TypedArray
,DataView
,Blob
, or string. - An object containing the following properties:
type
-
A string that is one of
"write"
,"seek"
, or"truncate"
. data
-
The file data to write. Can be an
ArrayBuffer
,TypedArray
,DataView
,Blob
, or string. This property is required iftype
is set to"write"
. position
-
The byte position the current file cursor should move to if type
"seek"
is used. Can also be set iftype
is"write"
, in which case the write will start at the specified position. size
-
A number representing the number of bytes the stream should contain. This property is required if
type
is set to"truncate"
.
- The file data to write, in the form of an
Return value
A Promise
that returns undefined
.
Exceptions
NotAllowedError
DOMException
-
Thrown if
PermissionStatus.state
is notgranted
. QuotaExceededError
DOMException
-
Thrown if the new size of the file is larger than the original size of the file, and exceeds the browser's storage quota.
TypeError
-
Thrown if
data
is undefined, or ifposition
orsize
aren't valid.
Examples
The following asynchronous function opens the 'Save File' picker, which returns a FileSystemFileHandle
once a file is selected. From this, a writable stream is created using the FileSystemFileHandle.createWritable()
method.
A text string is then written to the stream, which is subsequently closed.
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);
}
}
The following examples show different options that can be passed into the write()
method.
// 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 });
Specifications
Specification |
---|
File System Standard # api-filesystemwritablefilestream-write |
Browser compatibility
BCD tables only load in the browser