Package-level declarations

Types

Link copied to clipboard
typealias AccessCallback = (err: AbstractJsException?) -> Unit

Describes the callback function shape which is provided to the access operation.

Link copied to clipboard
interface Dir
Link copied to clipboard
interface Dirent
Link copied to clipboard
interface FileHandle
Link copied to clipboard
interface FSWatcher
Link copied to clipboard
typealias MkdirCallback = (err: AbstractJsException?) -> Unit

Describes the callback function shape which is provided to the mkdir operation.

Link copied to clipboard
data class MkdirOptions(val recursive: Boolean = false, val mode: Int = 1911)

Describes options which can be passed to mkdir or mkdirSync.

Link copied to clipboard
typealias ReadFileCallback = (err: AbstractJsException?, data: Any?) -> Unit

Describes the callback function shape which is provided to the readFile operation.

Link copied to clipboard
data class ReadFileOptions(val encoding: StringOrBuffer? = null, val flag: String? = "r", val signal: AbortSignal? = null)

Describes the options which can be provided to a readFile operation.

Link copied to clipboard
interface ReadStream
Link copied to clipboard
interface StatFs
Link copied to clipboard
interface Stats
Link copied to clipboard
interface StatWatcher
Link copied to clipboard
typealias StringOrBuffer = Any

Describes a String or Buffer type, depending on the encoding context for a file operation.

Link copied to clipboard

Describes the callback function shape which is provided to the writeFile operation.

Link copied to clipboard
data class WriteFileOptions(val encoding: StringOrBuffer? = null, val flag: String? = "w", val mode: Int? = null, val signal: AbortSignal? = null)

Describes the options which can be provided to a writeFile operation.

Link copied to clipboard
interface WriteStream