XMLFS

Defined in: src/xml.ts:41

Extends

• AsyncFSMethods<this> & FileSystem<this>

Constructors

Constructor

new XMLFS(root?): XMLFS

Defined in: src/xml.ts:42

Parameters

root?

Element = ...

The root fs element

Returns

XMLFS

Overrides

Sync(FileSystem).constructor

Properties

_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

Sync(FileSystem)._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

Sync(FileSystem)._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

Sync(FileSystem).attributes

---

label?

optional label?: string

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

Inherited from

Sync(FileSystem).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

Sync(FileSystem).name

---

root

readonly root: Element

Defined in: src/xml.ts:46

The root fs element

---

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

Sync(FileSystem).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

Sync(FileSystem).uuid

Methods

add()

protected add(syscall, node, path, contents?): void

Defined in: src/xml.ts:166

Parameters

syscall

string

node

Element

path

string

contents?

boolean = false

Returns

void

---

create()

protected create(syscall, path, stats): Element

Defined in: src/xml.ts:151

Parameters

syscall

string

path

string

stats

Partial<InodeLike<number>> & Pick<StatsLike<number | bigint>, "mode">

Returns

Element

---

createFile()

abstract createFile(path, options): Promise<InodeLike<number>>

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

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Promise<InodeLike<number>>

Inherited from

Sync(FileSystem).createFile

---

createFileSync()

createFileSync(path, options): Inode

Defined in: src/xml.ts:68

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Inode

Overrides

Sync(FileSystem).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

WebAccessFS.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

Sync(FileSystem).existsSync

---

get()

protected get(syscall, path): Element

Defined in: src/xml.ts:142

Parameters

syscall

string

path

string

Returns

Element

---

link()

abstract link(target, link): Promise<void>

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

Parameters

target

string

link

string

Returns

Promise<void>

Inherited from

Sync(FileSystem).link

---

linkSync()

linkSync(target, link): void

Defined in: src/xml.ts:113

Parameters

target

string

link

string

Returns

void

Overrides

Sync(FileSystem).linkSync

---

mkdir()

abstract mkdir(path, options): Promise<InodeLike<number>>

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

Parameters

path

string

options

CreationOptions

Returns

Promise<InodeLike<number>>

Inherited from

Sync(FileSystem).mkdir

---

mkdirSync()

mkdirSync(path, options): InodeLike

Defined in: src/xml.ts:92

Parameters

path

string

options

CreationOptions

Returns

InodeLike

Overrides

Sync(FileSystem).mkdirSync

---

read()

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

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

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

Promise<void>

Inherited from

Sync(FileSystem).read

---

readdir()

abstract readdir(path): Promise<string[]>

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

Parameters

path

string

Returns

Promise<string[]>

Inherited from

Sync(FileSystem).readdir

---

readdirSync()

readdirSync(path): string[]

Defined in: src/xml.ts:103

Parameters

path

string

Returns

string[]

Overrides

Sync(FileSystem).readdirSync

---

readSync()

readSync(path, buffer, offset, end): void

Defined in: src/xml.ts:125

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

void

Overrides

Sync(FileSystem).readSync

---

ready()

ready(): Promise<void>

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

Returns

Promise<void>

Inherited from

Sync(FileSystem).ready

---

readySync()

readySync(): void

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

Returns

void

Inherited from

Sync(FileSystem).readySync

---

remove()

protected remove(syscall, node, path, contents?): void

Defined in: src/xml.ts:181

Parameters

syscall

string

node

Element

path

string

contents?

boolean = false

Returns

void

---

rename()

abstract rename(oldPath, newPath): Promise<void>

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

Parameters

oldPath

string

newPath

string

Returns

Promise<void>

Inherited from

Sync(FileSystem).rename

---

renameSync()

renameSync(oldPath, newPath): void

Defined in: src/xml.ts:58

Parameters

oldPath

string

newPath

string

Returns

void

Overrides

Sync(FileSystem).renameSync

---

rmdir()

abstract rmdir(path): Promise<void>

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

Parameters

path

string

Returns

Promise<void>

Inherited from

Sync(FileSystem).rmdir

---

rmdirSync()

rmdirSync(path): void

Defined in: src/xml.ts:85

Parameters

path

string

Returns

void

Overrides

Sync(FileSystem).rmdirSync

---

stat()

abstract stat(path): Promise<InodeLike<number>>

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

Parameters

path

string

Returns

Promise<InodeLike<number>>

Inherited from

Sync(FileSystem).stat

---

statSync()

statSync(path): Inode

Defined in: src/xml.ts:64

Parameters

path

string

Returns

Inode

Overrides

Sync(FileSystem).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

Sync(FileSystem).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

Sync(FileSystem).streamWrite

---

sync()

abstract sync(): Promise<void>

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

Returns

Promise<void>

Inherited from

Sync(FileSystem).sync

---

syncSync()

syncSync(): void

Defined in: src/xml.ts:123

Returns

void

Overrides

Sync(FileSystem).syncSync

---

toString()

toString(): string

Defined in: src/xml.ts:138

Returns

string

Overrides

Sync(FileSystem).toString

---

touch()

abstract touch(path, metadata): Promise<void>

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

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

Promise<void>

Inherited from

Sync(FileSystem).touch

---

touchSync()

touchSync(path, metadata): void

Defined in: src/xml.ts:118

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

void

Overrides

Sync(FileSystem).touchSync

---

unlink()

abstract unlink(path): Promise<void>

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

Parameters

path

string

Returns

Promise<void>

Inherited from

Sync(FileSystem).unlink

---

unlinkSync()

unlinkSync(path): void

Defined in: src/xml.ts:79

Parameters

path

string

Returns

void

Overrides

Sync(FileSystem).unlinkSync

---

usage()

usage(): UsageInfo

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

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

Sync(FileSystem).usage

---

write()

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

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

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>

Inherited from

Sync(FileSystem).write

---

writeSync()

writeSync(path, buffer, offset): void

Defined in: src/xml.ts:131

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

Overrides

Sync(FileSystem).writeSync