Skip to content

Function: nodeDirectory()

Documentation / @wtf/platform-fs-node / handles / nodeDirectory

function nodeDirectory(path, options?): Promise<NodeShapedDirectoryHandle>;

Defined in: packages/platform-fs-node/src/handles.ts:41

The handle of the folder of path, relative to the folder the process is in, on the disk: a folder not there fails a NotFoundError, or, with create, is made, with each folder on the way; a file there fails a TypeMismatchError. Its handles are of Node’s fs/promises, a snapshot a File of openAsBlob, read as it streams, and its sync access of the synchronous calls of node:fs.

Parameters

ParameterType
pathstring
options?FromNodeShapedOptions

Returns

Promise<NodeShapedDirectoryHandle>