Class WebAccessFS

Hierarchy

AsyncMixin<this> & IndexFS<this>
- WebAccessFS

Index

Constructors

constructor

new WebAccessFS(handle: FileSystemDirectoryHandle): WebAccessFS
Parameters
- handle: FileSystemDirectoryHandle
Returns WebAccessFS
Overrides Async(IndexFS).constructor
- Defined in src/access.ts:83

Properties

`Protected`_handles

_handles: Map<string, FileSystemHandle> = ...

`Protected` `Optional` `Internal`_mountPoint

_mountPoint?: string

The last place this file system was mounted

`Protected` `Internal`_uuid

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

The UUID of the file system.

`Readonly`attributes

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

See

FileSystemAttributes

`Readonly`index

index: Index

`Optional`label

label?: string

`Readonly`name

name: string

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

`Readonly`type

type: number

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

Accessors

uuid

get uuid(): `${string}-${string}-${string}-${string}-${string}`
Returns `${string}-${string}-${string}-${string}-${string}`
Inherited from Async(IndexFS).uuid
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:149

Methods

`Protected`_remove

_remove(path: string, isUnlink: boolean): void
Parameters
- path: string
- isUnlink: boolean
Returns void
Inherited from Async(IndexFS)._remove
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:23

`Protected`create

create(path: string, options: CreationOptions): Inode
Parameters
- path: string
- options: CreationOptions
Returns Inode
Inherited from Async(IndexFS).create
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:30

createFile

createFile(path: string, options: CreationOptions): Promise<InodeLike>
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns Promise<InodeLike>
Inherited from Async(IndexFS).createFile
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:31

`Abstract`createFileSync

createFileSync(path: string, options: CreationOptions): InodeLike
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Inherited from Async(IndexFS).createFileSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:188

exists

exists(path: string): Promise<boolean>
Test whether or not path exists.
Parameters
- path: string
Returns Promise<boolean>
Inherited from Async(IndexFS).exists
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:200

existsSync

existsSync(path: string): boolean
Test whether or not path exists.
Parameters
- path: string
Returns boolean
Inherited from Async(IndexFS).existsSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:204

`Protected`get

get<const T extends null | FileSystemHandleKind>(
kind?: T,
path: string,
): T extends FileSystemHandleKind ? HKindToType<T<T>> : FileSystemHandle
Type Parameters
- const T extends null | FileSystemHandleKind
Parameters
- kind: T = ...
- path: string
Returns T extends FileSystemHandleKind ? HKindToType<T<T>> : FileSystemHandle
- Defined in src/access.ts:177

link

link(target: string, link: string): Promise<void>
Parameters
- target: string
- link: string
Returns Promise<void>
Inherited from Async(IndexFS).link
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:35

`Abstract`linkSync

linkSync(target: string, link: string): void
Parameters
- target: string
- link: string
Returns void
Inherited from Async(IndexFS).linkSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:206

mkdir

mkdir(path: string, options: CreationOptions): Promise<InodeLike>
Parameters
- path: string
- options: CreationOptions
Returns Promise<InodeLike>
Overrides Async(IndexFS).mkdir
- Defined in src/access.ts:169

`Abstract`mkdirSync

mkdirSync(path: string, options: CreationOptions): InodeLike
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Inherited from Async(IndexFS).mkdirSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:194

queueDone

queueDone(): Promise<void>
Returns Promise<void>
Deprecated
Use sync instead
Inherited from Async(IndexFS).queueDone
- Defined in node_modules/@zenfs/core/dist/mixins/async.d.ts:22

read

read(
    path: string,
    buffer: Uint8Array,
    offset: number,
    end: number,
): Promise<void>
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
- Defined in src/access.ts:98

readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Inherited from Async(IndexFS).readdir
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:37

`Abstract`readdirSync

readdirSync(path: string): string[]
Parameters
- path: string
Returns string[]
Inherited from Async(IndexFS).readdirSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:196

`Abstract`readSync

readSync(path: string, buffer: Uint8Array, start: number, end: number): void
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
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:222

ready

ready(): Promise<void>
Returns Promise<void>
Deprecated
Use sync instead
Inherited from Async(IndexFS).ready
- Defined in node_modules/@zenfs/core/dist/mixins/async.d.ts:26

`Protected`remove

remove(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides Async(IndexFS).remove
- Defined in src/access.ts:89

`Protected`removeSync

removeSync(): void
Returns void
Overrides Async(IndexFS).removeSync
- Defined in src/access.ts:94

rename

rename(oldPath: string, newPath: string): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Inherited from Async(IndexFS).rename
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:17

`Abstract`renameSync

renameSync(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
Inherited from Async(IndexFS).renameSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:174

rmdir

rmdir(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from Async(IndexFS).rmdir
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:28

`Abstract`rmdirSync

rmdirSync(path: string): void
Parameters
- path: string
Returns void
Inherited from Async(IndexFS).rmdirSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:192

stat

stat(path: string): Promise<Inode>
Parameters
- path: string
Returns Promise<Inode>
Inherited from Async(IndexFS).stat
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:19

`Abstract`statSync

statSync(path: string): InodeLike
Parameters
- path: string
Returns InodeLike
Inherited from Async(IndexFS).statSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:176
statSync(path: string): Inode
Parameters
- path: string
Returns Inode
Inherited from Async(IndexFS).statSync
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:20

streamRead

streamRead(path: string, options: StreamOptions): ReadableStream
Read a file using a stream.
Parameters
- path: string
- options: StreamOptions
Returns ReadableStream
Inherited from Async(IndexFS).streamRead
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:239

streamWrite

streamWrite(path: string, options: StreamOptions): WritableStream
Write a file using stream.
Parameters
- path: string
- options: StreamOptions
Returns WritableStream
Inherited from Async(IndexFS).streamWrite
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:244

sync

sync(): Promise<void>
Returns Promise<void>
Inherited from Async(IndexFS).sync
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:39

`Abstract`syncSync

syncSync(): void
Returns void
Inherited from Async(IndexFS).syncSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:208

toString

toString(): string
Returns string
Inherited from Async(IndexFS).toString
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:165

touch

touch(path: string, metadata: InodeLike): Promise<void>
Modify metadata.
Parameters
- path: string
- metadata: InodeLike
Returns Promise<void>
Inherited from Async(IndexFS).touch
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:21

`Abstract`touchSync

touchSync(path: string, metadata: Partial<InodeLike>): void
Modify metadata.
Parameters
- path: string
- metadata: Partial<InodeLike>
Returns void
Inherited from Async(IndexFS).touchSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:180
touchSync(path: string, metadata: InodeLike): void
Modify metadata.
Parameters
- path: string
- metadata: InodeLike
Returns void
Inherited from Async(IndexFS).touchSync
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:22

unlink

unlink(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from Async(IndexFS).unlink
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:26

`Abstract`unlinkSync

unlinkSync(path: string): void
Parameters
- path: string
Returns void
Inherited from Async(IndexFS).unlinkSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:190

usage

usage(): UsageInfo
Experimental
Default implementation.

Returns UsageInfo
Todo
Implement
Inherited from Async(IndexFS).usage
- Defined in node_modules/@zenfs/core/dist/internal/index_fs.d.ts:12

write

write(path: string, buffer: Uint8Array, offset: number): Promise<void>
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
- Defined in src/access.ts:116

`Abstract`writeSync

writeSync(path: string, buffer: Uint8Array, offset: number): void
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
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:234

Class WebAccessFS

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebAccessFS

Properties

Protected_handles

Protected Optional Internal_mountPoint

Protected Internal_uuid

Readonlyattributes

See

Readonlyindex

Optionallabel

Readonlyname

Readonlytype

Accessors

uuid

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

Methods

Protected_remove

Parameters

Returns void

Protectedcreate

Parameters

Returns Inode

createFile

Parameters

Returns Promise<InodeLike>

AbstractcreateFileSync

Parameters

Returns InodeLike

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

Protectedget

Type Parameters

Parameters

Returns T extends FileSystemHandleKind ? HKindToType<T<T>> : FileSystemHandle

link

Parameters

Returns Promise<void>

AbstractlinkSync

Parameters

Returns void

mkdir

Parameters

Returns Promise<InodeLike>

AbstractmkdirSync

Parameters

Returns InodeLike

queueDone

Returns Promise<void>

Deprecated

read

Parameters

Returns Promise<void>

readdir

Parameters

Returns Promise<string[]>

AbstractreaddirSync

Parameters

Returns string[]

AbstractreadSync

Parameters

Returns void

ready

Returns Promise<void>

Deprecated

Protectedremove

Parameters

Returns Promise<void>

`Protected`_handles

`Protected` `Optional` `Internal`_mountPoint

`Protected` `Internal`_uuid

`Readonly`attributes

`Readonly`index

`Optional`label

`Readonly`name

`Readonly`type

`Protected`_remove

`Protected`create

`Abstract`createFileSync

`Protected`get

`Abstract`linkSync

`Abstract`mkdirSync

`Abstract`readdirSync

`Abstract`readSync

`Protected`remove

`Protected`removeSync

`Abstract`renameSync

`Abstract`rmdirSync

`Abstract`statSync

`Abstract`syncSync

`Abstract`touchSync

`Abstract`unlinkSync

`Abstract`writeSync