Class: MemoryDirectoryHandle

Documentation / @wtf/platform-fs-memory / handles / MemoryDirectoryHandle

Defined in: packages/platform-fs-memory/src/handles.ts:476

A folder’s handle, of a file system in memory: each entry of it found, made, listed and removed, each handle of one made by handleOf; and the path of an entry in it. MemoryDirectoryHandle.root makes the root of a new file system, of the class it is called of.

Extends

MemoryHandle

Constructors

Constructor

new MemoryDirectoryHandle(fs, parts): MemoryDirectoryHandle;

Defined in: packages/platform-fs-memory/src/handles.ts:262

The handle of the entry of parts, its names from the root, of the file system fs.

Parameters

Parameter	Type
`fs`	`MemoryFileSystem`
`parts`	readonly `string`[]

Returns

MemoryDirectoryHandle

Inherited from

MemoryHandle.constructor

Properties

Property	Modifier	Type	Overrides	Defined in
`kind`	`readonly`	`"directory"`	`MemoryHandle`.`kind`	packages/platform-fs-memory/src/handles.ts:477

Accessors

name

Get Signature

get name(): string;

Defined in: packages/platform-fs-memory/src/handles.ts:283

Returns

string

Inherited from

MemoryHandle.name

Methods

[asyncIterator]()

asyncIterator: AsyncGenerator<[string, MemoryDirectoryHandle | MemoryFileHandle]>;

Defined in: packages/platform-fs-memory/src/handles.ts:535

Returns

AsyncGenerator<[string, MemoryDirectoryHandle | MemoryFileHandle]>

entries()

entries(): AsyncGenerator<[string, MemoryDirectoryHandle | MemoryFileHandle]>;

Defined in: packages/platform-fs-memory/src/handles.ts:522

Each entry, by its name: a link as what it leads to, and none of a link that leads to nothing.

Returns

AsyncGenerator<[string, MemoryDirectoryHandle | MemoryFileHandle]>

getDirectoryHandle()

getDirectoryHandle(name, options?): Promise<MemoryDirectoryHandle>;

Defined in: packages/platform-fs-memory/src/handles.ts:501

Parameters

Parameter	Type
`name`	`string`
`options`	`FileSystemGetOptions`

Returns

Promise<MemoryDirectoryHandle>

getFileHandle()

getFileHandle(name, options?): Promise<MemoryFileHandle>;

Defined in: packages/platform-fs-memory/src/handles.ts:497

Parameters

Parameter	Type
`name`	`string`
`options`	`FileSystemGetOptions`

Returns

Promise<MemoryFileHandle>

isSameEntry()

isSameEntry(other): Promise<boolean>;

Defined in: packages/platform-fs-memory/src/handles.ts:314

Parameters

Parameter	Type
`other`	`FileSystemHandle`

Returns

Promise<boolean>

Inherited from

MemoryHandle.isSameEntry

keys()

keys(): AsyncGenerator<string>;

Defined in: packages/platform-fs-memory/src/handles.ts:527

Returns

AsyncGenerator<string>

move()

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

Defined in: packages/platform-fs-memory/src/handles.ts:330

Parameters

Parameter	Type
`destination`	\| `string` \| `FileSystemDirectoryHandle`
`newName?`	`string`

Returns

Promise<void>

Inherited from

MemoryHandle.move

removeEntry()

removeEntry(name, __namedParameters?): Promise<void>;

Defined in: packages/platform-fs-memory/src/handles.ts:508

Parameters

Parameter	Type
`name`	`string`
`__namedParameters`	`FileSystemRemoveOptions`

Returns

Promise<void>

resolve()

resolve(possibleDescendant): Promise<string[] | null>;

Defined in: packages/platform-fs-memory/src/handles.ts:515

Parameters

Parameter	Type
`possibleDescendant`	`FileSystemHandle`

Returns

Promise<string[] | null>

values()

values(): AsyncGenerator<MemoryDirectoryHandle | MemoryFileHandle>;

Defined in: packages/platform-fs-memory/src/handles.ts:531

Returns

AsyncGenerator<MemoryDirectoryHandle | MemoryFileHandle>

root()

static root<D>(this, options?): D;

Defined in: packages/platform-fs-memory/src/handles.ts:484

The root of a new file system in memory, an instance of the class this is called of, whose entries are made by its handleOf: with ignoreCase, a name finds an entry of another case, or form of Unicode; now is the time it stamps a change with, Date.now()’s by default.

Type Parameters

Type Parameter
`D` extends `MemoryDirectoryHandle`

Parameters

Parameter	Type
`this`	(`fs`, `parts`) => `D`
`options`	`MemoryDirectoryOptions`

Returns

D