kotlin-browser/web.fs/FileSystemDirectoryEntry

FileSystemDirectoryEntry

open class FileSystemDirectoryEntry : FileSystemEntry(source)

The FileSystemDirectoryEntry interface of the File and Directory Entries API represents a directory in a file system.

Properties

The read-only filesystem property of the FileSystemEntry interface contains a FileSystem object that represents the file system on which the entry resides.

fullPath

val fullPath: String

The read-only fullPath property of the FileSystemEntry interface returns a string specifying the full, absolute path from the file system's root to the file represented by the entry.

isDirectory

val isDirectory: Boolean

The read-only isDirectory property of the FileSystemEntry interface is true if the entry represents a directory (meaning it's a FileSystemDirectoryEntry) and false if it's not.

isFile

val isFile: Boolean

The read-only isFile property of the FileSystemEntry interface is true if the entry represents a file (meaning it's a FileSystemFileEntry) and false if it's not.

name

val name: String

The read-only name property of the FileSystemEntry interface returns a string specifying the entry's name; this is the entry within its parent directory (the last component of the path as indicated by the FileSystemEntry.fullPath property).

Functions

createReader

fun createReader(): FileSystemDirectoryReader

The FileSystemDirectoryEntry interface's method createReader() returns a FileSystemDirectoryReader object which can be used to read the entries in the directory.

getDirectory

suspend fun FileSystemDirectoryEntry.getDirectory(path: String? = undefined, options: FileSystemFlags = unsafeJso()): FileSystemEntry

The FileSystemDirectoryEntry interface's method getDirectory() returns a somewhere within the directory subtree rooted at the directory on which it's called.

getDirectoryWithCallbacks

fun getDirectoryWithCallbacks(path: String? = definedExternally, options: FileSystemFlags = definedExternally, successCallback: FileSystemEntryCallback = definedExternally, errorCallback: ErrorCallback = definedExternally)

The FileSystemDirectoryEntry interface's method getDirectory() returns a FileSystemDirectoryEntry object corresponding to a directory contained somewhere within the directory subtree rooted at the directory on which it's called.

getFile

suspend fun FileSystemDirectoryEntry.getFile(path: String? = undefined, options: FileSystemFlags = unsafeJso()): FileSystemEntry

The FileSystemDirectoryEntry interface's method getFile() returns a within the directory subtree rooted at the directory on which it's called.

getFileWithCallbacks

fun getFileWithCallbacks(path: String? = definedExternally, options: FileSystemFlags = definedExternally, successCallback: FileSystemEntryCallback = definedExternally, errorCallback: ErrorCallback = definedExternally)

The FileSystemDirectoryEntry interface's method getFile() returns a FileSystemFileEntry object corresponding to a file contained somewhere within the directory subtree rooted at the directory on which it's called.

getParent

suspend fun FileSystemEntry.getParent(): FileSystemEntry

The FileSystemEntry interface's method getParent() obtains a ``js-nolint getParent(successCallback, errorCallback) getParent(successCallback) `` - successCallback - : A function which is called when the parent directory entry has been retrieved.

getParentWithCallbacks

fun getParentWithCallbacks(successCallback: FileSystemEntryCallback = definedExternally, errorCallback: ErrorCallback = definedExternally)

The FileSystemEntry interface's method getParent() obtains a FileSystemDirectoryEntry.