Interface ReadFileConfig

configuration options for the readTextFile and readFile functions.

interface ReadFileConfig {
signal?: AbortSignal;
}

Properties

signal?: AbortSignal

provide an optional abort signal to allow the cancellation of the file reading operation.

if the signal becomes aborted, the read file operation will be stopped and the promise returned will be rejected with an AbortError.

undefined