kotlin-browser/web.fs/FileSystemFileHandle

FileSystemFileHandle

open class FileSystemFileHandle : FileSystemHandle, Serializable(source)

The FileSystemFileHandle interface of the File System API represents a handle to a file system entry. The interface is accessed through the window.showOpenFilePicker() method. Available only in secure contexts.

MDN Reference

Properties

kind

open override val kind: FileSystemHandleKind.file

The kind read-only property of the FileSystemHandle interface returns the type of entry. This is 'file' if the associated entry is a file or 'directory'. It is used to distinguish files from directories when iterating over the contents of a directory.

name

val name: String

The name read-only property of the FileSystemHandle interface returns the name of the entry represented by handle.

Functions

createSyncAccessHandle

inline suspend fun FileSystemFileHandle.createSyncAccessHandle(): FileSystemSyncAccessHandle

The createSyncAccessHandle() method of the FileSystemFileHandle interface returns a Promise which resolves to a FileSystemSyncAccessHandle object that can be used to synchronously read from and write to a file. The synchronous nature of this method brings performance advantages, but it is only usable inside dedicated Web Workers for files within the origin private file system.

createSyncAccessHandleAsync

fun createSyncAccessHandleAsync(): Promise<FileSystemSyncAccessHandle>

createWritable

inline suspend fun FileSystemFileHandle.createWritable(): FileSystemWritableFileStream

inline suspend fun FileSystemFileHandle.createWritable(options: FileSystemCreateWritableOptions): FileSystemWritableFileStream

The createWritable() method of the FileSystemFileHandle interface creates a FileSystemWritableFileStream that can be used to write to a file. The method returns a Promise which resolves to this created stream.

createWritableAsync

fun createWritableAsync(options: FileSystemCreateWritableOptions = definedExternally): Promise<FileSystemWritableFileStream>

getFile

inline suspend fun FileSystemFileHandle.getFile(): File

The getFile() method of the FileSystemFileHandle interface returns a Promise which resolves to a File object representing the state on disk of the entry represented by the handle.

getFileAsync

fun getFileAsync(): Promise<File>

The getFile() method of the FileSystemFileHandle interface returns a Promise which resolves to a File object representing the state on disk of the entry represented by the handle.

isSameEntry

inline suspend fun FileSystemHandle.isSameEntry(other: FileSystemHandle): Boolean

The isSameEntry() method of the FileSystemHandle interface compares two handles to see if the associated entries (either a file or directory) match.

isSameEntryAsync

fun isSameEntryAsync(other: FileSystemHandle): Promise<JsBoolean>

The isSameEntry() method of the FileSystemHandle interface compares two handles to see if the associated entries (either a file or directory) match.