Function readFile

  • readFile(path, options?): Promise<Buffer>

  • Asynchronously reads the entire contents of a file.

    Parameters

    • path: PathLike | FileHandle
    • Optionaloptions: null | {
          encoding?: null;
          flag?: OpenMode;
      }

    Returns Promise<Buffer>

    the file data

    Option

    encoding The string encoding for the file contents. Defaults to null.

    Option

    flag Defaults to 'r'.

  • readFile(path, options): Promise<string>

  • Parameters

    • path: PathLike | FileHandle
    • options: BufferEncoding | {
          encoding: BufferEncoding;
          flag?: OpenMode | undefined;
      }

    Returns Promise<string>

  • readFile(path, options?): Promise<string | Buffer>

  • Parameters

    • path: PathLike | FileHandle
    • Optionaloptions: null | BufferEncoding | ObjectEncodingOptions & {
          flag?: OpenMode | undefined;
      }

    Returns Promise<string | Buffer>

Settings

Member Visibility