WebAccessFS

Defined in: src/access.ts:56

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:114

Parameters

root

FileSystemDirectoryHandle

disableHandleCache?

boolean = false

Returns

WebAccessFS

Overrides

Async(IndexFS).constructor

Properties

_crossCopySemaphore?

protected optional _crossCopySemaphore?: Semaphore

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

Internal

Restrict how many files can be copied across at once

Inherited from

Async(IndexFS)._crossCopySemaphore

---

_handles

protected _handles: Map<string, FileSystemHandle>

Defined in: src/access.ts:62

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:144

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:150

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:155

See

FileSystemAttributes

Inherited from

Async(IndexFS).attributes

---

disableHandleCache

protected readonly disableHandleCache: boolean = false

Defined in: src/access.ts:116

---

index

readonly index: Index

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

Inherited from

Async(IndexFS).index

---

label?

optional label?: string

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

Inherited from

Async(IndexFS).label

---

name

readonly name: string

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

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:115

---

type

readonly type: number

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

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:151

Returns

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

Inherited from

Async(IndexFS).uuid

Methods

_create()

protected _create(path, inode): Promise<void>

Defined in: src/access.ts:277

Create a new file in the underlying backend

Parameters

path

string

inode

Inode

Returns

Promise<void>

Overrides

Async(IndexFS)._create

---

_createSync()?

protected optional _createSync(path, inode): void

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

Create a new file in the underlying backend

Parameters

path

string

inode

Inode

Returns

void

Inherited from

Async(IndexFS)._createSync

---

_mkdir()

_mkdir(path): Promise<void>

Defined in: src/access.ts:283

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:40

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:25

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:36

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:37

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:191

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:38

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:203

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:207

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:289

Type Parameters

T

T extends FileSystemHandleKind | null

Parameters

kind?

T = ...

path

string

Returns

Promise<HKindToType<T>>

---

ioctl()

ioctl(context, command, …args): Promise<any>

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

Internal

Parameters

context

IoctlContext

command

number

args

…any[]

Returns

Promise<any>

Inherited from

Async(IndexFS).ioctl

---

ioctlSync()

ioctlSync(context, command, …args): any

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

Internal

Parameters

context

IoctlContext

command

number

args

…any[]

Returns

any

Inherited from

XMLFS.ioctlSync

---

link()

link(target, link): Promise<void>

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

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:209

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:41

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:197

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:42

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:21

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:199

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:183

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:199

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:225

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:22

Returns

Promise<void>

Inherited from

Async(IndexFS).ready

---

readySync()

readySync(): void

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

Returns

void

Inherited from

XMLFS.readySync

---

remove()

protected remove(path): Promise<void>

Defined in: src/access.ts:188

Parameters

path

string

Returns

Promise<void>

Overrides

Async(IndexFS).remove

---

removeSync()

protected removeSync(): void

Defined in: src/access.ts:195

Returns

void

Overrides

Async(IndexFS).removeSync

---

rename()

rename(oldPath, newPath): Promise<void>

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

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:177

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:30

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:195

Parameters

path

string

Returns

void

Inherited from

Async(IndexFS).rmdirSync

---

stat()

stat(path): Promise<Inode>

Defined in: src/access.ts:123

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:179

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:22

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:242

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:247

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:23

Returns

Promise<void>

Inherited from

Async(IndexFS).sync

---

syncSync()

abstract syncSync(): void

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

Returns

void

Inherited from

Async(IndexFS).syncSync

---

toString()

toString(): string

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

Returns

string

Inherited from

Async(IndexFS).toString

---

touch()

touch(path, metadata): Promise<void>

Defined in: src/access.ts:156

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:183

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:24

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:28

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:193

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:14

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:221

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:237

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