Skip to content
FKNdocs
GitHub

@fkn/lib/cloud/fs/promises

Variables

Section titled “Variables”

access

Section titled “access”
access: (path) => Promise<void>;

Parameters

Section titled “Parameters”
path
Section titled “path”

PathLike

Returns

Section titled “Returns”

Promise<void>

lstat

Section titled “lstat”
lstat: (path) => Promise<Stats>;

Parameters

Section titled “Parameters”
path
Section titled “path”

PathLike

Returns

Section titled “Returns”

Promise<Stats>

mkdir

Section titled “mkdir”
mkdir: (_path?, _options?) => Promise<void>;

Parameters

Section titled “Parameters”
_path?
Section titled “_path?”

PathLike

_options?
Section titled “_options?”

MakeOptions

Returns

Section titled “Returns”

Promise<void>

readdir

Section titled “readdir”
readdir: (path) => Promise<string[]>;

Parameters

Section titled “Parameters”
path
Section titled “path”

PathLike

Returns

Section titled “Returns”

Promise<string[]>

readFile

Section titled “readFile”
readFile: (path, options?) => Promise<string | Buffer<ArrayBufferLike>>;

Parameters

Section titled “Parameters”
path
Section titled “path”

PathLike

options?
Section titled “options?”

ReadOptions

Returns

Section titled “Returns”

Promise<string | Buffer<ArrayBufferLike>>

rename

Section titled “rename”
rename: (from, to) => Promise<void>;

Parameters

Section titled “Parameters”
from
Section titled “from”

PathLike

to
Section titled “to”

PathLike

Returns

Section titled “Returns”

Promise<void>

rm

Section titled “rm”
rm: (path, options?) => Promise<void>;

Parameters

Section titled “Parameters”
path
Section titled “path”

PathLike

options?
Section titled “options?”
recursive?
Section titled “recursive?”

boolean

Returns

Section titled “Returns”

Promise<void>

rmdir

Section titled “rmdir”
rmdir: (path, options?) => Promise<void>;

Parameters

Section titled “Parameters”
path
Section titled “path”

PathLike

options?
Section titled “options?”
recursive?
Section titled “recursive?”

boolean

Returns

Section titled “Returns”

Promise<void>

stat

Section titled “stat”
stat: (path) => Promise<Stats>;

Parameters

Section titled “Parameters”
path
Section titled “path”

PathLike

Returns

Section titled “Returns”

Promise<Stats>

Section titled “unlink”
unlink: (path) => Promise<void>;

Parameters

Section titled “Parameters”
path
Section titled “path”

PathLike

Returns

Section titled “Returns”

Promise<void>

writeFile

Section titled “writeFile”
writeFile: (path, data, options?) => Promise<void>;

Parameters

Section titled “Parameters”
path
Section titled “path”

PathLike

data
Section titled “data”

WriteData

options?
Section titled “options?”

WriteOptions

Returns

Section titled “Returns”

Promise<void>