Options
All
  • Public
  • Public/Protected
  • All
Menu

Callable

  • Asynchronously 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.

    • 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.

    • callback: NoParamCallback

    Returns void

  • Asynchronously 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.

    • callback: NoParamCallback

    Returns void

Index

Functions

Functions

__promisify__

  • Asynchronously 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 Promise<void>

Generated using TypeDoc