Function readFile

  • readFile(
        this: V_Context,
        path: PathLike | FileHandle,
        options?: null | { encoding?: null; flag?: OpenMode },
    ): Promise<Buffer>

  • Asynchronously reads the entire contents of a file.

    Parameters

    • this: V_Context
    • 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(
        this: V_Context,
        path: PathLike | FileHandle,
        options:
            | BufferEncoding
            | { encoding: BufferEncoding; flag?: OpenMode | undefined },
    ): Promise<string>

  • Asynchronously reads the entire contents of a file.

    Parameters

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

    Returns Promise<string>

    the file data

    Option

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

    Option

    flag Defaults to 'r'.

  • readFile(
        this: V_Context,
        path: PathLike | FileHandle,
        options?:
            | null
            | BufferEncoding
            | ObjectEncodingOptions & { flag?: OpenMode | undefined },
    ): Promise<string | Buffer>

  • Asynchronously reads the entire contents of a file.

    Parameters

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

    Returns Promise<string | Buffer>

    the file data

    Option

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

    Option

    flag Defaults to 'r'.

Settings

Member Visibility