ReadFileOptions

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

Options: fs.readFile

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

Parameters

encoding

The encoding to use for the file read operation; optional. If not specified, files are read as raw Buffer values; otherwise, the file is read as a string.

flag

The flag to use for the file read operation; defaults to r.

signal

Abort signal to use for the operation; optional.

Constructors

Link copied to clipboard
constructor(encoding: StringOrBuffer? = null, flag: String? = "r", signal: AbortSignal? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
val flag: String?
Link copied to clipboard
val signal: AbortSignal? = null