Class XMLFS

Hierarchy

AsyncFSMethods<this> & FileSystem<this>
- XMLFS

Index

Constructors

constructor

new XMLFS(root?: Element): XMLFS
Parameters
- root: Element = ...
  The root fs element
Returns XMLFS
Overrides Sync(FileSystem).constructor
- Defined in src/xml.ts:41

Properties

`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

`Optional`label

label?: string

`Readonly`name

name: string

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

`Readonly`root

root: Element = ...

The root fs element

`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 Sync(FileSystem).uuid
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:149

Methods

`Protected`add

add(syscall: string, node: Element, path: string, contents?: boolean): void
Parameters
- syscall: string
- node: Element
- path: string
- contents: boolean = false
Returns void
- Defined in src/xml.ts:165

`Protected`create

create(
    syscall: string,
    path: string,
    stats: Partial<InodeLike> & Pick<StatsLike<number | bigint>, "mode">,
): Element
Parameters
- syscall: string
- path: string
- stats: Partial<InodeLike> & Pick<StatsLike<number | bigint>, "mode">
Returns Element
- Defined in src/xml.ts:150

`Abstract`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 Sync(FileSystem).createFile
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:184

createFileSync

createFileSync(path: string, options: CreationOptions): Inode
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns Inode
Overrides Sync(FileSystem).createFileSync
- Defined in src/xml.ts:67

exists

exists(path: string): Promise<boolean>
Test whether or not path exists.
Parameters
- path: string
Returns Promise<boolean>
Inherited from Sync(FileSystem).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 Sync(FileSystem).existsSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:204

`Protected`get

get(syscall: string, path: string): Element
Parameters
- syscall: string
- path: string
Returns Element
- Defined in src/xml.ts:141

`Abstract`link

link(target: string, link: string): Promise<void>
Parameters
- target: string
- link: string
Returns Promise<void>
Inherited from Sync(FileSystem).link
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:205

linkSync

linkSync(target: string, link: string): void
Parameters
- target: string
- link: string
Returns void
Overrides Sync(FileSystem).linkSync
- Defined in src/xml.ts:112

`Abstract`mkdir

mkdir(path: string, options: CreationOptions): Promise<InodeLike>
Parameters
- path: string
- options: CreationOptions
Returns Promise<InodeLike>
Inherited from Sync(FileSystem).mkdir
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:193

mkdirSync

mkdirSync(path: string, options: CreationOptions): InodeLike
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Overrides Sync(FileSystem).mkdirSync
- Defined in src/xml.ts:91

`Abstract`read

read(
    path: string,
    buffer: Uint8Array,
    start: 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!
- 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
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:215

`Abstract`readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Inherited from Sync(FileSystem).readdir
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:195

readdirSync

readdirSync(path: string): string[]
Parameters
- path: string
Returns string[]
Overrides Sync(FileSystem).readdirSync
- Defined in src/xml.ts:102

readSync

readSync(path: string, buffer: Uint8Array, offset: 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!
- offset: number
- end: number
  The position in the file to stop reading
Returns void
Overrides Sync(FileSystem).readSync
- Defined in src/xml.ts:124

ready

ready(): Promise<void>
Returns Promise<void>
Inherited from Sync(FileSystem).ready
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:172

`Protected`remove

remove(syscall: string, node: Element, path: string, contents?: boolean): void
Parameters
- syscall: string
- node: Element
- path: string
- contents: boolean = false
Returns void
- Defined in src/xml.ts:180

`Abstract`rename

rename(oldPath: string, newPath: string): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Inherited from Sync(FileSystem).rename
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:173

renameSync

renameSync(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
Overrides Sync(FileSystem).renameSync
- Defined in src/xml.ts:57

`Abstract`rmdir

rmdir(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from Sync(FileSystem).rmdir
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:191

rmdirSync

rmdirSync(path: string): void
Parameters
- path: string
Returns void
Overrides Sync(FileSystem).rmdirSync
- Defined in src/xml.ts:84

`Abstract`stat

stat(path: string): Promise<InodeLike>
Parameters
- path: string
Returns Promise<InodeLike>
Inherited from Sync(FileSystem).stat
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:175

statSync

statSync(path: string): Inode
Parameters
- path: string
Returns Inode
Overrides Sync(FileSystem).statSync
- Defined in src/xml.ts:63

streamRead

streamRead(path: string, options: StreamOptions): ReadableStream
Read a file using a stream.
Parameters
- path: string
- options: StreamOptions
Returns ReadableStream
Inherited from Sync(FileSystem).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 Sync(FileSystem).streamWrite
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:244

`Abstract`sync

sync(): Promise<void>
Returns Promise<void>
Inherited from Sync(FileSystem).sync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:207

syncSync

syncSync(): void
Returns void
Overrides Sync(FileSystem).syncSync
- Defined in src/xml.ts:122

toString

toString(): string
Returns string
Overrides Sync(FileSystem).toString
- Defined in src/xml.ts:137

`Abstract`touch

touch(path: string, metadata: Partial<InodeLike>): Promise<void>
Modify metadata.
Parameters
- path: string
- metadata: Partial<InodeLike>
Returns Promise<void>
Inherited from Sync(FileSystem).touch
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:178

touchSync

touchSync(path: string, metadata: Partial<InodeLike>): void
Modify metadata.
Parameters
- path: string
- metadata: Partial<InodeLike>
Returns void
Overrides Sync(FileSystem).touchSync
- Defined in src/xml.ts:117

`Abstract`unlink

unlink(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from Sync(FileSystem).unlink
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:189

unlinkSync

unlinkSync(path: string): void
Parameters
- path: string
Returns void
Overrides Sync(FileSystem).unlinkSync
- Defined in src/xml.ts:78

usage

usage(): UsageInfo
Experimental
Default implementation.

Returns UsageInfo
Todo
Implement
Inherited from Sync(FileSystem).usage
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:171

`Abstract`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>
Inherited from Sync(FileSystem).write
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:228

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
Overrides Sync(FileSystem).writeSync
- Defined in src/xml.ts:130

Class XMLFS

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns XMLFS

Properties

Protected Optional Internal_mountPoint

Protected Internal_uuid

Readonlyattributes

See

Optionallabel

Readonlyname

Readonlyroot

Readonlytype

Accessors

uuid

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

Methods

Protectedadd

Parameters

Returns void

Protectedcreate

Parameters

Returns Element

AbstractcreateFile

Parameters

Returns Promise<InodeLike>

createFileSync

Parameters

Returns Inode

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

Protectedget

Parameters

Returns Element

Abstractlink

Parameters

Returns Promise<void>

linkSync

Parameters

Returns void

Abstractmkdir

Parameters

Returns Promise<InodeLike>

mkdirSync

Parameters

Returns InodeLike

Abstractread

Parameters

Returns Promise<void>

Abstractreaddir

Parameters

Returns Promise<string[]>

readdirSync

Parameters

Returns string[]

readSync

Parameters

Returns void

ready

Returns Promise<void>

Protectedremove

Parameters

Returns void

Abstractrename

Parameters

Returns Promise<void>

renameSync

Parameters

Returns void

`Protected` `Optional` `Internal`_mountPoint

`Protected` `Internal`_uuid

`Readonly`attributes

`Optional`label

`Readonly`name

`Readonly`root

`Readonly`type

`Protected`add

`Protected`create

`Abstract`createFile

`Protected`get

`Abstract`link

`Abstract`mkdir

`Abstract`read

`Abstract`readdir

`Protected`remove

`Abstract`rename

`Abstract`rmdir

`Abstract`stat

`Abstract`sync

`Abstract`touch

`Abstract`unlink

`Abstract`write