kotlin-browser/web.fs/FileSystemDirectoryHandle

FileSystemDirectoryHandle

sealed class FileSystemDirectoryHandle : FileSystemHandle, AsyncMapLike<JsString, FileSystemHandle> , Serializable(source)

The FileSystemDirectoryHandle interface of the File System API provides a handle to a file system directory. Available only in secure contexts.

MDN Reference

Properties

Link copied to clipboard
open override val kind: FileSystemHandleKind.directory

The kind read-only property of the FileSystemHandle interface returns the type of entry.

Link copied to clipboard
val name: String

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

Functions

Link copied to clipboard
Link copied to clipboard
open operator fun get(key: Symbol.asyncIterator): () -> AsyncIterator<Tuple2<JsString, FileSystemHandle>>
Link copied to clipboard
inline suspend fun FileSystemDirectoryHandle.getDirectoryHandle(name: String): FileSystemDirectoryHandle
inline suspend fun FileSystemDirectoryHandle.getDirectoryHandle(name: String, options: FileSystemGetDirectoryOptions): FileSystemDirectoryHandle

The getDirectoryHandle() method of the FileSystemDirectoryHandle interface returns a FileSystemDirectoryHandle for a subdirectory with the specified name within the directory handle on which the method is called.

Link copied to clipboard
fun getDirectoryHandleAsync(name: String, options: FileSystemGetDirectoryOptions = definedExternally): Promise<FileSystemDirectoryHandle>

The getDirectoryHandle() method of the FileSystemDirectoryHandle interface returns a FileSystemDirectoryHandle for a subdirectory with the specified name within the directory handle on which the method is called.

Link copied to clipboard
inline suspend fun FileSystemDirectoryHandle.getFileHandle(name: String): FileSystemFileHandle
inline suspend fun FileSystemDirectoryHandle.getFileHandle(name: String, options: FileSystemGetFileOptions): FileSystemFileHandle

The getFileHandle() method of the FileSystemDirectoryHandle interface returns a FileSystemFileHandle for a file with the specified name, within the directory the method is called.

Link copied to clipboard
fun getFileHandleAsync(name: String, options: FileSystemGetFileOptions = definedExternally): Promise<FileSystemFileHandle>

The getFileHandle() method of the FileSystemDirectoryHandle interface returns a FileSystemFileHandle for a file with the specified name, within the directory the method is called.

Link copied to clipboard
inline suspend fun FileSystemHandle.isSameEntry(other: FileSystemHandle): Boolean

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

Link copied to clipboard
fun isSameEntryAsync(other: FileSystemHandle): Promise<JsBoolean>

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

Link copied to clipboard
abstract fun keys(): AsyncIterator<JsString>
Link copied to clipboard
inline suspend fun FileSystemDirectoryHandle.removeEntry(name: String)
inline suspend fun FileSystemDirectoryHandle.removeEntry(name: String, options: FileSystemRemoveOptions)

The removeEntry() method of the FileSystemDirectoryHandle interface attempts to remove an entry if the directory handle contains a file or directory called the name specified.

Link copied to clipboard
fun removeEntryAsync(name: String, options: FileSystemRemoveOptions = definedExternally): Promise<Void?>

The removeEntry() method of the FileSystemDirectoryHandle interface attempts to remove an entry if the directory handle contains a file or directory called the name specified.

Link copied to clipboard
inline suspend fun FileSystemDirectoryHandle.resolve(possibleDescendant: FileSystemHandle): ReadonlyArray<JsString>?

The resolve() method of the FileSystemDirectoryHandle interface returns an Array of directory names from the parent handle to the specified child entry, with the name of the child entry as the last array item.

Link copied to clipboard
fun resolveAsync(possibleDescendant: FileSystemHandle): Promise<ReadonlyArray<JsString>?>

The resolve() method of the FileSystemDirectoryHandle interface returns an Array of directory names from the parent handle to the specified child entry, with the name of the child entry as the last array item.

Link copied to clipboard
abstract fun values(): AsyncIterator<FileSystemHandle>