graalvm/elide.runtime.intrinsics.js.node/NodeFilesystemAPI

NodeFilesystemAPI

@API
interface NodeFilesystemAPI : NodeAPI, FilesystemAPI, WritableFilesystemAPI

Node API: fs (Node)

Functions

Link copied to clipboard
abstract fun access(path: Value, callback: Value)

Tests a user's permissions for the file at the specified path; provides the results or an error to the callback. This variant specifies the default mode of F_OK.

abstract fun access(path: Path, mode: AccessMode = AccessMode.READ, callback: AccessCallback)

Tests a user's permissions for the file at the specified path; provides the results or an error to the callback. This is a host-side variant.

abstract fun access(path: Value, mode: Value, callback: Value)

Tests a user's permissions for the file at the specified path; provides the results or an error to the callback. This variant accepts a mode.

Link copied to clipboard
abstract fun accessSync(path: Value)

Tests a user's permissions for the file at the specified path; provides the results or an error to the callback. This variant specifies the default mode of F_OK and operates synchronously, raising an exception for failures.

abstract fun accessSync(path: Path, mode: AccessMode = AccessMode.READ)

Tests a user's permissions for the file at the specified path; provides the results or an error to the callback. This is a host-side variant that operates synchronously.

abstract fun accessSync(path: Value, mode: Value)

Tests a user's permissions for the file at the specified path; provides the results or an error to the callback. This variant accepts a mode and operates synchronously, raising an exception for failures.

Link copied to clipboard
abstract fun copyFile(src: Value, dest: Value, callback: Value)

Copies the contents at the provided src path to the provided dest path. callback is dispatched once the copy operation completes.

abstract fun copyFile(src: Path, dest: Path, mode: Int = 0, callback: (Throwable?) -> Unit? = null)
abstract fun copyFile(src: Value, dest: Value, mode: Value?, callback: Value)

Copies the contents at the provided src path to the provided dest path, using the given mode (if specified) as modifiers for the copy operation; default value for mode is 0.

Link copied to clipboard
abstract fun copyFileSync(src: Value, dest: Value)

Copies the contents at the provided src path to the provided dest path.

abstract fun copyFileSync(src: Path, dest: Path, mode: Int = 0)
abstract fun copyFileSync(src: Value, dest: Value, mode: Value?)

Copies the contents at the provided src path to the provided dest path, using the given mode (if specified) as modifiers for the copy operation; default value for mode is 0.

Link copied to clipboard
abstract fun exists(path: Path, callback: (Boolean) -> Unit)
abstract fun exists(path: Value, callback: Value)

Tests whether the file at the specified path exists; provides the results or an error to the callback.

Link copied to clipboard
abstract fun existsSync(path: Path): Boolean
abstract fun existsSync(path: Value): Boolean

Tests whether the file at the specified path exists; provides the results or an error to the callback.

Link copied to clipboard
abstract fun mkdir(path: Value, callback: Value?)
abstract fun mkdir(path: Value, options: Value?, callback: Value?)

Create a directory, asynchronously, specified by the provided path.

abstract fun mkdir(path: Path, options: MkdirOptions = MkdirOptions.DEFAULTS, callback: MkdirCallback)

Create a directory, synchronously, specified by the provided path.

Link copied to clipboard
abstract fun mkdirSync(path: Value): String?
abstract fun mkdirSync(path: Path, options: MkdirOptions = MkdirOptions.DEFAULTS): String?
abstract fun mkdirSync(path: Value, options: Value?): String?

Create a directory, synchronously, specified by the provided path.

Link copied to clipboard
abstract fun readFile(path: Path, options: ReadFileOptions = ReadFileOptions.DEFAULTS, callback: ReadFileCallback)
abstract fun readFile(path: Value, options: Value?, callback: ReadFileCallback? = null)

Reads the contents of a file at the specified path; provides the results or an error to the callback. This variant accepts a polyglot Value.

Link copied to clipboard
abstract fun readFileSync(path: Path, options: ReadFileOptions = ReadFileOptions.DEFAULTS): StringOrBuffer
abstract fun readFileSync(path: Value, options: Value? = null): StringOrBuffer

Reads the contents of a file at the specified path and returns the results synchronously. This variant accepts a plain Value.

Link copied to clipboard
abstract fun writeFile(path: Value, data: Value, callback: Value)
abstract fun writeFile(path: Path, data: ByteArray, options: WriteFileOptions = WriteFileOptions.DEFAULTS, callback: WriteFileCallback)
abstract fun writeFile(path: Path, data: String, options: WriteFileOptions = WriteFileOptions.DEFAULTS, callback: WriteFileCallback)
abstract fun writeFile(path: Value, data: Value, options: Value?, callback: Value)

Writes the contents of a file at the specified path; provides the results or an error to the callback. This variant accepts a polyglot Value.

Link copied to clipboard
abstract fun writeFileSync(path: Value, data: Value)
abstract fun writeFileSync(path: Value, data: Value, options: Value?)

Writes the contents of a file at the specified path; provides the results or an error to the callback. This variant accepts a polyglot Value.

abstract fun writeFileSync(path: Path, data: ByteArray, options: WriteFileOptions = WriteFileOptions.DEFAULTS)

Writes the contents of a file at the specified path synchronously; throws if an error prevents the file from being written. This variant accepts a ByteArray.

abstract fun writeFileSync(path: Path, data: String, options: WriteFileOptions = WriteFileOptions.DEFAULTS)

Writes the contents of a file at the specified path synchronously; throws if an error prevents the file from being written. This variant accepts a String.