readFileSync
external fun readFileSync(path: PathOrFileDescriptor, options: ReadFileSyncBufferOptions? = definedExternally): Buffer(source)
Returns the contents of the path.
For detailed information, see the documentation of the asynchronous version of this API: {@link readFile}.
If the encoding option is specified then this function returns a string. Otherwise it returns a buffer.
Similar to {@link readFile}, when the path is a directory, the behavior of fs.readFileSync() is platform-specific.
import { readFileSync } from 'node:fs';
// macOS, Linux, and Windows
readFileSync('<directory>');
// => [Error: EISDIR: illegal operation on a directory, read <directory>]
// FreeBSD
readFileSync('<directory>'); // => <data>Content copied to clipboard
Since
v0.1.8
Parameters
path
filename or file descriptor
external fun readFileSync(path: PathOrFileDescriptor, options: ReadFileSyncStringOptions): String(source)
external fun readFileSync(path: PathOrFileDescriptor, options: ReadFileSyncOptions? = definedExternally): Any(source)
external fun readFileSync(path: PathOrFileDescriptor, options: BufferEncoding? = definedExternally): Any(source)
Synchronously reads the entire contents of a file.
Parameters
path
A path to a file. If a URL is provided, it must use the file: protocol. If a file descriptor is provided, the underlying file will not be closed automatically.
options
Either the encoding for the result, or an object that contains the encoding and an optional flag. If a flag is not provided, it defaults to 'r'.