WebAccessFS

Defined in: src/access.ts:50

Internal

Todo

Consider supporting synchronous stuff with FileSystemFileHandle.createSyncAccessHandle()\

Extends

• AsyncMixin<this> & IndexFS<this>

Constructors

Constructor

new WebAccessFS(root, disableHandleCache?): WebAccessFS

Defined in: src/access.ts:110

Parameters

root

FileSystemDirectoryHandle

disableHandleCache?

boolean = false

Returns

WebAccessFS

Overrides

Async(IndexFS).constructor

Properties

_handles

protected _handles: Map<string, FileSystemHandle>

Defined in: src/access.ts:56

Used to speed up handle lookups. Without this, every lookup would be O(n) on the path length. With the cache, these become O(1) operations.

---

_mountPoint?

protected optional _mountPoint?: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:143

Internal

The last place this file system was mounted

Inherited from

Async(IndexFS)._mountPoint

---

_uuid

protected _uuid: `${string}-${string}-${string}-${string}-${string}`

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:149

Internal

The UUID of the file system.

Inherited from

Async(IndexFS)._uuid

---

attributes

readonly attributes: ConstMap<FileSystemAttributes, keyof FileSystemAttributes, void | CaseFold | undefined> & Map<string, any>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:154

See

FileSystemAttributes

Inherited from

Async(IndexFS).attributes

---

disableHandleCache

protected readonly disableHandleCache: boolean = false

Defined in: src/access.ts:112

---

index

readonly index: Index

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:10

Inherited from

Async(IndexFS).index

---

label?

optional label?: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:138

Inherited from

Async(IndexFS).label

---

name

readonly name: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:137

The name for this file system. For example, tmpfs for an in memory one

Inherited from

Async(IndexFS).name

---

root

protected readonly root: FileSystemDirectoryHandle

Defined in: src/access.ts:111

---

type

readonly type: number

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:132

A unique ID for this kind of file system. Currently unused internally, but could be used for partition tables or something

Inherited from

Async(IndexFS).type

Accessors

uuid

Get Signature

get uuid(): `${string}-${string}-${string}-${string}-${string}`

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:150

Returns

`${string}-${string}-${string}-${string}-${string}`

Inherited from

Async(IndexFS).uuid

Methods

_mkdir()

_mkdir(path): Promise<void>

Defined in: src/access.ts:272

Parameters

path

string

Returns

Promise<void>

Overrides

Async(IndexFS)._mkdir

---

_mkdirSync()?

protected optional _mkdirSync(path, options): void

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:34

Parameters

path

string

options

CreationOptions

Returns

void

Inherited from

Async(IndexFS)._mkdirSync

---

_remove()

protected _remove(path, isUnlink): void

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:23

Parameters

path

string

isUnlink

boolean

Returns

void

Inherited from

Async(IndexFS)._remove

---

create()

protected create(path, options): Inode

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:30

Parameters

path

string

options

CreationOptions

Returns

Inode

Inherited from

Async(IndexFS).create

---

createFile()

createFile(path, options): Promise<Inode>

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:31

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Promise<Inode>

Inherited from

Async(IndexFS).createFile

---

createFileSync()

Call Signature

abstract createFileSync(path, options): InodeLike

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:190

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

InodeLike

Inherited from

Async(IndexFS).createFileSync

Call Signature

abstract createFileSync(path, options): Inode

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:32

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Inode

Inherited from

Async(IndexFS).createFileSync

---

exists()

exists(path): Promise<boolean>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:202

Test whether or not path exists.

Parameters

path

string

Returns

Promise<boolean>

Inherited from

Async(IndexFS).exists

---

existsSync()

existsSync(path): boolean

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:206

Test whether or not path exists.

Parameters

path

string

Returns

boolean

Inherited from

Async(IndexFS).existsSync

---

get()

protected get<T>(kind?, path): Promise<HKindToType<T>>

Defined in: src/access.ts:278

Type Parameters

T

T extends FileSystemHandleKind | null

Parameters

kind?

T = ...

path

string

Returns

Promise<HKindToType<T>>

---

link()

link(target, link): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:37

Parameters

target

string

link

string

Returns

Promise<void>

Inherited from

Async(IndexFS).link

---

linkSync()

abstract linkSync(target, link): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:208

Parameters

target

string

link

string

Returns

void

Inherited from

Async(IndexFS).linkSync

---

mkdir()

mkdir(path, options): Promise<Inode>

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:35

Parameters

path

string

options

CreationOptions

Returns

Promise<Inode>

Inherited from

Async(IndexFS).mkdir

---

mkdirSync()

Call Signature

abstract mkdirSync(path, options): InodeLike

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:196

Parameters

path

string

options

CreationOptions

Returns

InodeLike

Inherited from

Async(IndexFS).mkdirSync

Call Signature

abstract mkdirSync(path, options): Inode

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:36

Parameters

path

string

options

CreationOptions

Returns

Inode

Inherited from

Async(IndexFS).mkdirSync

---

queueDone()

queueDone(): Promise<void>

Defined in: node_modules/@zenfs/core/dist/mixins/async.d.ts:22

Deprecated

Use `sync` instead

Returns

Promise<void>

Inherited from

Async(IndexFS).queueDone

---

read()

read(path, buffer, offset, end): Promise<void>

Defined in: src/access.ts:195

Reads into a buffer

Parameters

path

string

buffer

Uint8Array

The buffer to read into. You must set the byteOffset and byteLength appropriately!

offset

number

end

number

The position in the file to stop reading

Returns

Promise<void>

Overrides

Async(IndexFS).read

---

readdir()

readdir(path): Promise<string[]>

Defined in: src/access.ts:179

Parameters

path

string

Returns

Promise<string[]>

Overrides

Async(IndexFS).readdir

---

readdirSync()

abstract readdirSync(path): string[]

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:198

Parameters

path

string

Returns

string[]

Inherited from

Async(IndexFS).readdirSync

---

readSync()

abstract readSync(path, buffer, start, end): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:224

Reads into a buffer

Parameters

path

string

buffer

Uint8Array

The buffer to read into. You must set the byteOffset and byteLength appropriately!

start

number

The offset into the file to start reading from

end

number

The position in the file to stop reading

Returns

void

Inherited from

Async(IndexFS).readSync

---

ready()

ready(): Promise<void>

Defined in: node_modules/@zenfs/core/dist/mixins/async.d.ts:23

Returns

Promise<void>

Inherited from

Async(IndexFS).ready

---

readySync()

readySync(): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:174

Returns

void

Inherited from

XMLFS.readySync

---

remove()

protected remove(path): Promise<void>

Defined in: src/access.ts:184

Parameters

path

string

Returns

Promise<void>

Overrides

Async(IndexFS).remove

---

removeSync()

protected removeSync(): void

Defined in: src/access.ts:191

Returns

void

Overrides

Async(IndexFS).removeSync

---

rename()

rename(oldPath, newPath): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:17

Parameters

oldPath

string

newPath

string

Returns

Promise<void>

Inherited from

Async(IndexFS).rename

---

renameSync()

abstract renameSync(oldPath, newPath): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:176

Parameters

oldPath

string

newPath

string

Returns

void

Inherited from

Async(IndexFS).renameSync

---

rmdir()

rmdir(path): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:28

Parameters

path

string

Returns

Promise<void>

Inherited from

Async(IndexFS).rmdir

---

rmdirSync()

abstract rmdirSync(path): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:194

Parameters

path

string

Returns

void

Inherited from

Async(IndexFS).rmdirSync

---

stat()

stat(path): Promise<Inode>

Defined in: src/access.ts:119

Parameters

path

string

Returns

Promise<Inode>

Overrides

Async(IndexFS).stat

---

statSync()

Call Signature

abstract statSync(path): InodeLike

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:178

Parameters

path

string

Returns

InodeLike

Inherited from

Async(IndexFS).statSync

Call Signature

abstract statSync(path): Inode

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:20

Parameters

path

string

Returns

Inode

Inherited from

Async(IndexFS).statSync

---

streamRead()

streamRead(path, options): ReadableStream

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:241

Read a file using a stream.

Parameters

path

string

options

StreamOptions

Returns

ReadableStream

Inherited from

Async(IndexFS).streamRead

---

streamWrite()

streamWrite(path, options): WritableStream

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:246

Write a file using stream.

Parameters

path

string

options

StreamOptions

Returns

WritableStream

Inherited from

Async(IndexFS).streamWrite

---

sync()

sync(): Promise<void>

Defined in: node_modules/@zenfs/core/dist/mixins/async.d.ts:24

Returns

Promise<void>

Inherited from

Async(IndexFS).sync

---

syncSync()

abstract syncSync(): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:210

Returns

void

Inherited from

Async(IndexFS).syncSync

---

toString()

toString(): string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:166

Returns

string

Inherited from

Async(IndexFS).toString

---

touch()

touch(path, metadata): Promise<void>

Defined in: src/access.ts:152

Parameters

path

string

metadata

InodeLike

Returns

Promise<void>

Overrides

Async(IndexFS).touch

---

touchSync()

Call Signature

abstract touchSync(path, metadata): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:182

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

void

Inherited from

Async(IndexFS).touchSync

Call Signature

abstract touchSync(path, metadata): void

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:22

Modify metadata.

Parameters

path

string

metadata

InodeLike

Returns

void

Inherited from

Async(IndexFS).touchSync

---

unlink()

unlink(path): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:26

Parameters

path

string

Returns

Promise<void>

Inherited from

Async(IndexFS).unlink

---

unlinkSync()

abstract unlinkSync(path): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:192

Parameters

path

string

Returns

void

Inherited from

Async(IndexFS).unlinkSync

---

usage()

usage(): UsageInfo

Defined in: node_modules/@zenfs/core/dist/internal/index_fs.d.ts:12

Default implementation.

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

UsageInfo

Todo

Implement

Inherited from

Async(IndexFS).usage

---

write()

write(path, buffer, offset): Promise<void>

Defined in: src/access.ts:217

Writes a buffer to a file

Parameters

path

string

buffer

Uint8Array

The buffer to write. You must set the byteOffset and byteLength appropriately!

offset

number

The offset in the file to start writing

Returns

Promise<void>

Overrides

Async(IndexFS).write

---

writeSync()

abstract writeSync(path, buffer, offset): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:236

Writes a buffer to a file

Parameters

path

string

buffer

Uint8Array

The buffer to write. You must set the byteOffset and byteLength appropriately!

offset

number

The offset in the file to start writing

Returns

void

Inherited from

Async(IndexFS).writeSync