On this page

These types are not exported by webpack, but they are available to TypeScript consumers.

Attributes
lstat:LStatTypes
lstat method
readdir:ReaddirTypes
readdir method
readFile:ReadFileTypes
read file method
readJson:(pathOrFileDescription: PathOrFileDescriptorTypes, callback: (err: Error | ErrnoException | null, result?: JsonObjectTypes) => void) => void
read json method
readlink:ReadlinkTypes
read link method
realpath:RealPathTypes
realpath method
stat:StatTypes
stat method

Returns location of targetPath relative to rootPath.

Attributes
dirname:(dirname: string) => string
join:(path1: string, path2: string) => string
lstat:LStatFs
lstatSync:LStatSync
purge:(value?: string | string[] | Set<string>, options?: { exact?: boolean }) => void
readdir:ReaddirFs
readdirSync:ReaddirSync
readFile:ReadFileFs
readFileSync:ReadFileSync
readJson:(pathOrFileDescriptor: PathOrFileDescriptorFs, callback: (err: Error | ErrnoException | null, result?: JsonObjectFs) => void) => void
readJsonSync:(pathOrFileDescriptor: PathOrFileDescriptorFs) => JsonObjectFs
readlink:ReadlinkFs
readlinkSync:ReadlinkSync
realpath:RealPathFs
realpathSync:RealPathSync
relative:(from: string, to: string) => string
stat:StatFs
statSync:StatSync

Returns location of targetPath relative to rootPath.

Attributes
createReadStream:(path: PathLikeFs, options?: "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ReadStreamOptions) => ReadableStream
dirname:(dirname: string) => string
join:(path1: string, path2: string) => string
lstat:LStatFs
mkdir:Mkdir
readdir:ReaddirFs
readFile:ReadFileFs
relative:(from: string, to: string) => string
rmdir:(file: PathLikeFs, callback: (err: ErrnoException | null) => void) => void
stat:StatFs
unlink:(pathLike: PathLikeFs, callback: (err: ErrnoException | null) => void) => void
writeFile:WriteFile

Returns location of targetPath relative to rootPath.

Attributes
watch:(files: Iterable<string>, directories: Iterable<string>, missing: Iterable<string>, startTime: number, options: WatchOptions, callback: (err: Error | null, timeInfoEntries1?: Map<string, "ignore" | EntryTypesIndex | OnlySafeTimeEntry | ExistenceOnlyTimeEntryTypesIndex | null>, timeInfoEntries2?: Map<string, "ignore" | EntryTypesIndex | OnlySafeTimeEntry | ExistenceOnlyTimeEntryTypesIndex | null>, changes?: Set<string>, removals?: Set<string>) => void, callbackUndelayed: (value: string, num: number) => void) => Watcher
Type:InputFileSystem & OutputFileSystem & IntermediateFileSystemExtras