External module "fs/read-file/docs/types/index.d"

Index

Interfaces

Type aliases

Callback

Variables

readFile

Type aliases

Callback

Callback: (err: Error | null, file: Buffer | string) => void

Callback invoked upon reading a file.

param: error object
param: file contents

Type declaration

- (err: Error | null, file: Buffer | string): void
- Parameters
  - err: Error | null
  - file: Buffer | string
  Returns void

Variables

Export assignment readFile

readFile: ReadFile

Asynchronously reads the entire contents of a file.

param: file path or file descriptor
param: options
param: file encoding
param: file status flag
param: callback to invoke after reading file contents