FileSystem

Methods

appendFile()

appendFile(path, content): Promise<void>;

Parameters

Parameter	Type
path	string
content	string | Uint8Array<ArrayBufferLike>

Returns

Promise<void>

---

cp()

cp(
   src,
   dest,
options?): Promise<void>;

Parameters

Parameter	Type
src	string
dest	string
options?	CpOptions

Returns

Promise<void>

---

exists()

exists(path): Promise<boolean>;

Parameters

Parameter	Type
path	string

Returns

Promise<boolean>

---

glob()

glob(pattern): Promise<string[]>;

Parameters

Parameter	Type
pattern	string

Returns

Promise<string[]>

---

lstat()

lstat(path): Promise<FsStat>;

Parameters

Parameter	Type
path	string

Returns

Promise<FsStat>

---

mkdir()

mkdir(path, options?): Promise<void>;

Parameters

Parameter	Type
path	string
options?	MkdirOptions

Returns

Promise<void>

---

mv()

mv(src, dest): Promise<void>;

Parameters

Parameter	Type
src	string
dest	string

Returns

Promise<void>

---

readdir()

readdir(path): Promise<string[]>;

Parameters

Parameter	Type
path	string

Returns

Promise<string[]>

---

readdirWithFileTypes()

readdirWithFileTypes(path): Promise<FileSystemDirent[]>;

Parameters

Parameter	Type
path	string

Returns

Promise<FileSystemDirent[]>

---

readFile()

readFile(path): Promise<string>;

Parameters

Parameter	Type
path	string

Returns

Promise<string>

---

readFileBytes()

readFileBytes(path): Promise<Uint8Array<ArrayBufferLike>>;

Parameters

Parameter	Type
path	string

Returns

Promise<Uint8Array<ArrayBufferLike>>

---

readlink()

readlink(path): Promise<string>;

Parameters

Parameter	Type
path	string

Returns

Promise<string>

---

realpath()

realpath(path): Promise<string>;

Parameters

Parameter	Type
path	string

Returns

Promise<string>

---

resolvePath()

resolvePath(base, path): string;

Parameters

Parameter	Type
base	string
path	string

Returns

string

---

rm()

rm(path, options?): Promise<void>;

Parameters

Parameter	Type
path	string
options?	RmOptions

Returns

Promise<void>

---

stat()

stat(path): Promise<FsStat>;

Parameters

Parameter	Type
path	string

Returns

Promise<FsStat>

---

symlink()

symlink(target, linkPath): Promise<void>;

Parameters

Parameter	Type
target	string
linkPath	string

Returns

Promise<void>

---

writeFile()

writeFile(path, content): Promise<void>;

Parameters

Parameter	Type
path	string
content	string

Returns

Promise<void>

---

writeFileBytes()

writeFileBytes(path, content): Promise<void>;

Parameters

Parameter	Type
path	string
content	Uint8Array

Returns

Promise<void>