Class: NodeShapedFileHandle

Documentation / @wtf/platform-fs-adapter / handles / NodeShapedFileHandle

Defined in: packages/platform-fs-adapter/src/handles.ts:312

A file’s handle, of a file system shaped as Node’s: its snapshot, its writable, of mode: 'exclusive' too, and, of a file system given its synchronous calls, its sync access handle, which a file system without them leaves out.

Extends

• NodeShapedHandle

Constructors

Constructor

new NodeShapedFileHandle(context, path): NodeShapedFileHandle;

Defined in: packages/platform-fs-adapter/src/handles.ts:322

Parameters

Parameter	Type
context	NodeShapedContext
path	string

Returns

NodeShapedFileHandle

Overrides

NodeShapedHandle.constructor

Properties

Property	Modifier	Type	Description	Overrides	Defined in
createSyncAccessHandle?	readonly	() => Promise<FileSystemSyncAccessHandle>	The file, to read and write synchronously, held until the handle closes: of a file system given its synchronous calls, sync; none of one without them.	-	packages/platform-fs-adapter/src/handles.ts:320
exclusive	readonly	true	-	-	packages/platform-fs-adapter/src/handles.ts:314
kind	readonly	"file"	-	NodeShapedHandle.kind	packages/platform-fs-adapter/src/handles.ts:313

Accessors

name

Get Signature

get name(): string;

Defined in: packages/platform-fs-adapter/src/handles.ts:215

Returns

string

Inherited from

NodeShapedHandle.name

Methods

createWritable()

createWritable(__namedParameters?): Promise<FileSystemWritableFileStream>;

Defined in: packages/platform-fs-adapter/src/handles.ts:348

Parameters

Parameter	Type
__namedParameters	FileSystemCreateWritableOptions

Returns

Promise<FileSystemWritableFileStream>

---

getFile()

getFile(): Promise<File>;

Defined in: packages/platform-fs-adapter/src/handles.ts:344

Returns

Promise<File>

---

isSameEntry()

isSameEntry(other): Promise<boolean>;

Defined in: packages/platform-fs-adapter/src/handles.ts:253

Parameters

Parameter	Type
other	FileSystemHandle

Returns

Promise<boolean>

Inherited from

NodeShapedHandle.isSameEntry

---

move()

move(destination, newName?): Promise<void>;

Defined in: packages/platform-fs-adapter/src/handles.ts:270

Parameters

Parameter	Type
destination	| string | FileSystemDirectoryHandle
newName?	string

Returns

Promise<void>

Inherited from

NodeShapedHandle.move