filename or file descriptor
Optional options: { encoding?: null; flag?: string }Optional encoding?: nullOptional flag?: stringSynchronously reads the entire contents of a file.
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.
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'.
Synchronously reads the entire contents of a file.
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.
Optional options: BufferEncoding | "fs".ObjectEncodingOptions & { flag?: string }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'.
Returns the contents of the path.
For detailed information, see the documentation of the asynchronous version of this API: readFile.
If the encoding option is specified then this function returns a
string. Otherwise it returns a buffer.
Similar to readFile, when the path is a directory, the behavior offs.readFileSync() is platform-specific.
import { readFileSync } from 'fs';
// macOS, Linux, and Windows
readFileSync('<directory>');
// => [Error: EISDIR: illegal operation on a directory, read <directory>]
// FreeBSD
readFileSync('<directory>'); // => <data>
v0.0.67
filename or file descriptor
Optional options: { encoding?: null; flag?: string }Optional encoding?: nullOptional flag?: stringSynchronously reads the entire contents of a file.
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.
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'.
Synchronously reads the entire contents of a file.
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.
Optional options: BufferEncoding | "fs".ObjectEncodingOptions & { flag?: string }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'.
Generated using TypeDoc
Returns the contents of the
path.For detailed information, see the documentation of the asynchronous version of this API: readFile.
If the
encodingoption is specified then this function returns a string. Otherwise it returns a buffer.Similar to readFile, when the path is a directory, the behavior of
fs.readFileSync()is platform-specific.Since
v0.0.67