Module readFile

Callable

• readFile(path: PathLike | number, options: object | undefined | null, callback: function): void
• readFile(path: PathLike | number, options: object | string, callback: function): void
• readFile(path: PathLike | number, options: object | string | undefined | null, callback: function): void
• readFile(path: PathLike | number, callback: function): void

• Asynchronously 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. If a file descriptor is provided, the underlying file will not be closed automatically.

  • options: object | undefined | null

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

  • callback: function

    • • (err: ErrnoException | null, data: Buffer): void

      • Parameters

        • err: ErrnoException | null

        • data: Buffer

        Returns void

  Returns void

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

  • callback: function

    • • (err: ErrnoException | null, data: string): void

      • Parameters

        • err: ErrnoException | null

        • data: string

        Returns void

  Returns void

• Asynchronously 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 | string | undefined | 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'.

  • callback: function

    • • (err: ErrnoException | null, data: string | Buffer): void

      • Parameters

        • err: ErrnoException | null

        • data: string | Buffer

        Returns void

  Returns void

• Asynchronously 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. If a file descriptor is provided, the underlying file will not be closed automatically.

  • callback: function

    • • (err: ErrnoException | null, data: Buffer): void

      • Parameters

        • err: ErrnoException | null

        • data: Buffer

        Returns void

  Returns void