Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "fs"

Index

Modules

Classes

Interfaces

Type aliases

Functions

Type aliases

BufferEncodingOption

BufferEncodingOption: "buffer" | object

Mode

Mode: number | string

NoParamCallback

NoParamCallback: function

Type declaration

OpenMode

OpenMode: number | string

PathLike

PathLike: string | Buffer | URL

Valid types for path values in "fs".

WriteFileOptions

WriteFileOptions: BaseEncodingOptions & object | string | null

Functions

accessSync

  • accessSync(path: PathLike, mode?: number): void

  • Synchronously tests a user's permissions for the file specified by path.

    Parameters

    • path: PathLike

      A path to a file or directory. If a URL is provided, it must use the file: protocol. URL support is experimental.

    • Optional mode: number

    Returns void

appendFileSync

  • Synchronously append data to a file, creating the file if it does not exist.

    Parameters

    • file: PathLike | number

      A path to a file. If a URL is provided, it must use the file: protocol. URL support is experimental. If a file descriptor is provided, the underlying file will not be closed automatically.

    • data: string | Uint8Array

      The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string.

    • Optional options: WriteFileOptions

      Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. If encoding is not supplied, the default of 'utf8' is used. If mode is not supplied, the default of 0o666 is used. If mode is a string, it is parsed as an octal integer. If flag is not supplied, the default of 'a' is used.

    Returns void

chmodSync

  • Synchronous chmod(2) - Change permissions of a file.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • mode: Mode

      A file mode. If a string is passed, it is parsed as an octal integer.

    Returns void

chownSync

  • chownSync(path: PathLike, uid: number, gid: number): void

  • Synchronous chown(2) - Change ownership of a file.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • uid: number
    • gid: number

    Returns void

closeSync

  • closeSync(fd: number): void

  • Synchronous close(2) - close a file descriptor.

    Parameters

    • fd: number

      A file descriptor.

    Returns void

copyFileSync

  • Synchronously copies src to dest. By default, dest is overwritten if it already exists. Node.js makes no guarantees about the atomicity of the copy operation. If an error occurs after the destination file has been opened for writing, Node.js will attempt to remove the destination.

    Parameters

    • src: PathLike

      A path to the source file.

    • dest: PathLike

      A path to the destination file.

    • Optional flags: number

      An optional integer that specifies the behavior of the copy operation. The only supported flag is fs.constants.COPYFILE_EXCL, which causes the copy operation to fail if dest already exists.

    Returns void

createReadStream

  • Returns a new ReadStream object.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol. URL support is experimental.

    • Optional options: string | object

    Returns ReadStream

createWriteStream

  • Returns a new WriteStream object.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol. URL support is experimental.

    • Optional options: string | object

    Returns WriteStream

existsSync

  • Synchronously tests whether or not the given path exists by checking with the file system.

    Parameters

    • path: PathLike

      A path to a file or directory. If a URL is provided, it must use the file: protocol. URL support is experimental.

    Returns boolean

fchmodSync

  • fchmodSync(fd: number, mode: Mode): void

  • Synchronous fchmod(2) - Change permissions of a file.

    Parameters

    • fd: number

      A file descriptor.

    • mode: Mode

      A file mode. If a string is passed, it is parsed as an octal integer.

    Returns void

fchownSync

  • fchownSync(fd: number, uid: number, gid: number): void

  • Synchronous fchown(2) - Change ownership of a file.

    Parameters

    • fd: number

      A file descriptor.

    • uid: number
    • gid: number

    Returns void

fdatasyncSync

  • fdatasyncSync(fd: number): void

  • Synchronous fdatasync(2) - synchronize a file's in-core state with storage device.

    Parameters

    • fd: number

      A file descriptor.

    Returns void

fstatSync

  • Synchronous fstat(2) - Get file status.

    Parameters

    • fd: number

      A file descriptor.

    • Optional options: StatOptions & object

    Returns Stats

  • Parameters

    Returns BigIntStats

  • Parameters

    Returns Stats | BigIntStats

fsyncSync

  • fsyncSync(fd: number): void

  • Synchronous fsync(2) - synchronize a file's in-core state with the underlying storage device.

    Parameters

    • fd: number

      A file descriptor.

    Returns void

ftruncateSync

  • ftruncateSync(fd: number, len?: number | null): void

  • Synchronous ftruncate(2) - Truncate a file to a specified length.

    Parameters

    • fd: number

      A file descriptor.

    • Optional len: number | null

      If not specified, defaults to 0.

    Returns void

futimesSync

  • futimesSync(fd: number, atime: string | number | Date, mtime: string | number | Date): void

  • Synchronously change file timestamps of the file referenced by the supplied file descriptor.

    Parameters

    • fd: number

      A file descriptor.

    • atime: string | number | Date

      The last access time. If a string is provided, it will be coerced to number.

    • mtime: string | number | Date

      The last modified time. If a string is provided, it will be coerced to number.

    Returns void

lchmodSync

  • Synchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • mode: Mode

      A file mode. If a string is passed, it is parsed as an octal integer.

    Returns void

lchownSync

  • lchownSync(path: PathLike, uid: number, gid: number): void

  • Synchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • uid: number
    • gid: number

    Returns void

linkSync

  • Synchronous link(2) - Create a new link (also known as a hard link) to an existing file.

    Parameters

    • existingPath: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • newPath: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    Returns void

lstatSync

  • Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: StatOptions & object

    Returns Stats

  • Parameters

    Returns BigIntStats

  • Parameters

    Returns Stats | BigIntStats

lutimesSync

  • lutimesSync(path: PathLike, atime: string | number | Date, mtime: string | number | Date): void

  • Change the file system timestamps of the symbolic link referenced by path. Returns undefined, or throws an exception when parameters are incorrect or the operation fails. This is the synchronous version of fs.lutimes().

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • atime: string | number | Date

      The last access time. If a string is provided, it will be coerced to number.

    • mtime: string | number | Date

      The last modified time. If a string is provided, it will be coerced to number.

    Returns void

mkdirSync

  • Synchronous mkdir(2) - create a directory.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • options: MakeDirectoryOptions & object

      Either the file mode, or an object optionally specifying the file mode and whether parent folders should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to 0o777.

    Returns string | undefined

  • Synchronous mkdir(2) - create a directory.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: Mode | MakeDirectoryOptions & object | null

      Either the file mode, or an object optionally specifying the file mode and whether parent folders should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to 0o777.

    Returns void

  • Synchronous mkdir(2) - create a directory.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: Mode | MakeDirectoryOptions | null

      Either the file mode, or an object optionally specifying the file mode and whether parent folders should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to 0o777.

    Returns string | undefined

mkdtempSync

  • Synchronously creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory.

    Parameters

    • prefix: string
    • Optional options: BaseEncodingOptions | BufferEncoding | null

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    Returns string

  • Synchronously creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory.

    Parameters

    • prefix: string
    • options: BufferEncodingOption

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    Returns Buffer

  • Synchronously creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory.

    Parameters

    • prefix: string
    • Optional options: BaseEncodingOptions | string | null

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    Returns string | Buffer

openSync

  • Synchronous open(2) - open and possibly create a file, returning a file descriptor..

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • flags: OpenMode
    • Optional mode: Mode | null

      A file mode. If a string is passed, it is parsed as an octal integer. If not supplied, defaults to 0o666.

    Returns number

opendirSync

  • Parameters

    Returns Dir

readFileSync

  • Synchronously reads the entire contents of a file.

    Parameters

    • path: PathLike | number

      A path to a file. If a URL is provided, it must use the file: protocol. URL support is experimental. If a file descriptor is provided, the underlying file will not be closed automatically.

    • Optional options: object | null

      An object that may contain an optional flag. If a flag is not provided, it defaults to 'r'.

    Returns Buffer

  • Synchronously reads the entire contents of a file.

    Parameters

    • path: PathLike | number

      A path to a file. If a URL is provided, it must use the file: protocol. URL support is experimental. If a file descriptor is provided, the underlying file will not be closed automatically.

    • options: object | BufferEncoding

      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 string

  • Synchronously reads the entire contents of a file.

    Parameters

    • path: PathLike | number

      A path to a file. If a URL is provided, it must use the file: protocol. URL support is experimental. If a file descriptor is provided, the underlying file will not be closed automatically.

    • Optional options: BaseEncodingOptions & object | BufferEncoding | null

      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 string | Buffer

readSync

  • Synchronously reads data from the file referenced by the supplied file descriptor, returning the number of bytes read.

    Parameters

    • fd: number

      A file descriptor.

    • buffer: ArrayBufferView

      The buffer that the data will be written to.

    • offset: number

      The offset in the buffer at which to start writing.

    • length: number

      The number of bytes to read.

    • position: number | null

      The offset from the beginning of the file from which data should be read. If null, data will be read from the current position.

    Returns number

  • Similar to the above fs.readSync function, this version takes an optional options object. If no options object is specified, it will default with the above values.

    Parameters

    Returns number

readdirSync

  • Synchronous readdir(3) - read a directory.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: object | BufferEncoding | null

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    Returns string[]

  • Synchronous readdir(3) - read a directory.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • options: object | "buffer"

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    Returns Buffer[]

  • Synchronous readdir(3) - read a directory.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: BaseEncodingOptions & object | BufferEncoding | null

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    Returns string[] | Buffer[]

  • Synchronous readdir(3) - read a directory.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • options: BaseEncodingOptions & object

      If called with withFileTypes: true the result data will be an array of Dirent.

    Returns Dirent[]

readlinkSync

  • Synchronous readlink(2) - read value of a symbolic link.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: BaseEncodingOptions | BufferEncoding | null

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    Returns string

  • Synchronous readlink(2) - read value of a symbolic link.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • options: BufferEncodingOption

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    Returns Buffer

  • Synchronous readlink(2) - read value of a symbolic link.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: BaseEncodingOptions | string | null

      The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

    Returns string | Buffer

readvSync

  • readvSync(fd: number, buffers: ReadonlyArray<ArrayBufferView>, position?: number): number

  • See readv.

    Parameters

    • fd: number
    • buffers: ReadonlyArray<ArrayBufferView>
    • Optional position: number

    Returns number

renameSync

  • Synchronous rename(2) - Change the name or location of a file or directory.

    Parameters

    • oldPath: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol. URL support is experimental.

    • newPath: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol. URL support is experimental.

    Returns void

rmSync

  • Synchronously removes files and directories (modeled on the standard POSIX rm utility).

    Parameters

    Returns void

rmdirSync

  • Synchronous rmdir(2) - delete a directory.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: RmDirOptions

    Returns void

statSync

  • Synchronous stat(2) - Get file status.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional options: StatOptions & object

    Returns Stats

  • Parameters

    Returns BigIntStats

  • Parameters

    Returns Stats | BigIntStats

symlinkSync

  • Synchronous symlink(2) - Create a new symbolic link to an existing file.

    Parameters

    • target: PathLike

      A path to an existing file. If a URL is provided, it must use the file: protocol.

    • path: PathLike

      A path to the new symlink. If a URL is provided, it must use the file: protocol.

    • Optional type: Type | null

      May be set to 'dir', 'file', or 'junction' (default is 'file') and is only available on Windows (ignored on other platforms). When using 'junction', the target argument will automatically be normalized to an absolute path.

    Returns void

truncateSync

  • truncateSync(path: PathLike, len?: number | null): void

  • Synchronous truncate(2) - Truncate a file to a specified length.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optional len: number | null

      If not specified, defaults to 0.

    Returns void

unlinkSync

  • Synchronous unlink(2) - delete a name and possibly the file it refers to.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    Returns void

unwatchFile

  • unwatchFile(filename: PathLike, listener?: function): void

  • Stop watching for changes on filename.

    Parameters

    • filename: PathLike

      A path to a file or directory. If a URL is provided, it must use the file: protocol. URL support is experimental.

    • Optional listener: function

    Returns void

utimesSync

  • utimesSync(path: PathLike, atime: string | number | Date, mtime: string | number | Date): void

  • Synchronously change file timestamps of the file referenced by the supplied path.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • atime: string | number | Date

      The last access time. If a string is provided, it will be coerced to number.

    • mtime: string | number | Date

      The last modified time. If a string is provided, it will be coerced to number.

    Returns void

watch

  • Watch for changes on filename, where filename is either a file or a directory, returning an FSWatcher.

    Parameters

    • filename: PathLike

      A path to a file or directory. If a URL is provided, it must use the file: protocol. URL support is experimental.

    • options: object | BufferEncoding | undefined | null

      Either the encoding for the filename provided to the listener, or an object optionally specifying encoding, persistent, and recursive options. If encoding is not supplied, the default of 'utf8' is used. If persistent is not supplied, the default of true is used. If recursive is not supplied, the default of false is used.

    • Optional listener: function
        • (event: "rename" | "change", filename: string): void

        • Parameters

          • event: "rename" | "change"
          • filename: string

          Returns void

    Returns FSWatcher

  • Watch for changes on filename, where filename is either a file or a directory, returning an FSWatcher.

    Parameters

    • filename: PathLike

      A path to a file or directory. If a URL is provided, it must use the file: protocol. URL support is experimental.

    • options: object | "buffer"

      Either the encoding for the filename provided to the listener, or an object optionally specifying encoding, persistent, and recursive options. If encoding is not supplied, the default of 'utf8' is used. If persistent is not supplied, the default of true is used. If recursive is not supplied, the default of false is used.

    • Optional listener: function
        • (event: "rename" | "change", filename: Buffer): void

        • Parameters

          • event: "rename" | "change"
          • filename: Buffer

          Returns void

    Returns FSWatcher

  • Watch for changes on filename, where filename is either a file or a directory, returning an FSWatcher.

    Parameters

    • filename: PathLike

      A path to a file or directory. If a URL is provided, it must use the file: protocol. URL support is experimental.

    • options: object | string | null

      Either the encoding for the filename provided to the listener, or an object optionally specifying encoding, persistent, and recursive options. If encoding is not supplied, the default of 'utf8' is used. If persistent is not supplied, the default of true is used. If recursive is not supplied, the default of false is used.

    • Optional listener: function
        • (event: "rename" | "change", filename: string | Buffer): void

        • Parameters

          • event: "rename" | "change"
          • filename: string | Buffer

          Returns void

    Returns FSWatcher

  • Watch for changes on filename, where filename is either a file or a directory, returning an FSWatcher.

    Parameters

    • filename: PathLike

      A path to a file or directory. If a URL is provided, it must use the file: protocol. URL support is experimental.

    • Optional listener: function
        • (event: "rename" | "change", filename: string): any

        • Parameters

          • event: "rename" | "change"
          • filename: string

          Returns any

    Returns FSWatcher

watchFile

  • watchFile(filename: PathLike, options: object | undefined, listener: function): void
  • watchFile(filename: PathLike, listener: function): void

  • Watch for changes on filename. The callback listener will be called each time the file is accessed.

    Parameters

    • filename: PathLike
    • options: object | undefined
    • listener: function

    Returns void

  • Watch for changes on filename. The callback listener will be called each time the file is accessed.

    Parameters

    • filename: PathLike

      A path to a file or directory. If a URL is provided, it must use the file: protocol. URL support is experimental.

    • listener: function

    Returns void

writeFileSync

  • Synchronously writes data to a file, replacing the file if it already exists.

    Parameters

    • path: PathLike | number

      A path to a file. If a URL is provided, it must use the file: protocol. URL support is experimental. If a file descriptor is provided, the underlying file will not be closed automatically.

    • data: string | ArrayBufferView

      The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string.

    • Optional options: WriteFileOptions

      Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. If encoding is not supplied, the default of 'utf8' is used. If mode is not supplied, the default of 0o666 is used. If mode is a string, it is parsed as an octal integer. If flag is not supplied, the default of 'w' is used.

    Returns void

writeSync

  • writeSync(fd: number, buffer: ArrayBufferView, offset?: number | null, length?: number | null, position?: number | null): number
  • writeSync(fd: number, string: string, position?: number | null, encoding?: BufferEncoding | null): number

  • Synchronously writes buffer to the file referenced by the supplied file descriptor, returning the number of bytes written.

    Parameters

    • fd: number

      A file descriptor.

    • buffer: ArrayBufferView
    • Optional offset: number | null

      The part of the buffer to be written. If not supplied, defaults to 0.

    • Optional length: number | null

      The number of bytes to write. If not supplied, defaults to buffer.length - offset.

    • Optional position: number | null

      The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.

    Returns number

  • Synchronously writes string to the file referenced by the supplied file descriptor, returning the number of bytes written.

    Parameters

    • fd: number

      A file descriptor.

    • string: string

      A string to write.

    • Optional position: number | null

      The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.

    • Optional encoding: BufferEncoding | null

      The expected string encoding.

    Returns number

writevSync

  • writevSync(fd: number, buffers: ReadonlyArray<ArrayBufferView>, position?: number): number

  • See writev.

    Parameters

    • fd: number
    • buffers: ReadonlyArray<ArrayBufferView>
    • Optional position: number

    Returns number

Generated using TypeDoc