Function readFile

readFile(
    this: unknown,
    path: PathLike | FileHandle,
    options?: { encoding?: null; flag?: OpenMode } & Abortable | null,
): Promise<NonSharedBuffer>
Asynchronously reads the entire contents of a file.
Parameters
- this: unknown
- path: PathLike | FileHandle
- Optionaloptions: { encoding?: null; flag?: OpenMode } & Abortable | null
Returns Promise<NonSharedBuffer>
the file data

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

Option
flag Defaults to 'r'.
- Defined in src/node/promises.ts:451
readFile(
    this: unknown,
    path: PathLike | FileHandle,
    options:
        | BufferEncoding
        | { encoding: BufferEncoding; flag?: OpenMode | undefined } & Abortable,
): Promise<string>
Asynchronously reads the entire contents of a file.
Parameters
- this: unknown
- path: PathLike | FileHandle
- options:
  | BufferEncoding
  | { encoding: BufferEncoding; flag?: OpenMode | undefined } & Abortable
Returns Promise<string>
the file data

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

Option
flag Defaults to 'r'.
- Defined in src/node/promises.ts:456
readFile(
    this: unknown,
    path: PathLike | FileHandle,
    _options?:
        | BufferEncoding
        | ObjectEncodingOptions & Abortable & { flag?: OpenMode | undefined }
        | null,
): Promise<string | NonSharedBuffer>
Asynchronously reads the entire contents of a file.
Parameters
- this: unknown
- path: PathLike | FileHandle
- Optional_options:
      | BufferEncoding
      | ObjectEncodingOptions & Abortable & { flag?: OpenMode | undefined }
      | null
Returns Promise<string | NonSharedBuffer>
the file data

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

Option
flag Defaults to 'r'.
- Defined in src/node/promises.ts:461

Function readFile

Parameters

Returns Promise<NonSharedBuffer>

Option

Option

Parameters

Returns Promise<string>

Option

Option

Parameters

Returns Promise<string | NonSharedBuffer>

Option

Option

Settings