Class PortFS

PortFS lets you access an FS instance that is running in a port, or the other way around.

Note that direct synchronous operations are not permitted on the PortFS, regardless of the configuration option of the remote FS.

Hierarchy

AsyncMixin<this> & FileSystem<this>
- PortFS

Index

Constructors

constructor

new PortFS(options: Options): PortFS
Constructs a new PortFS instance that connects with the FS running on options.port.
Parameters
- options: Options
Returns PortFS
Overrides Async(FileSystem).constructor
- Defined in src/backends/port/fs.ts:47

Properties

`Protected` `Optional` `Internal`_mountPoint

_mountPoint?: string

The last place this file system was mounted

`Readonly`attributes

attributes: ConstMap<FileSystemAttributes, keyof FileSystemAttributes, void> & Map<
string,
any,
> = ...

See

FileSystemAttributes

`Readonly`id

id: number

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

`Optional`label

label?: string

`Readonly`name

name: string

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

`Readonly`options

options: Options

`Readonly`port

port: Port

Methods

createFile

createFile(
    path: string,
    flag: string,
    mode: number,
    options: CreationOptions,
): Promise<File<FileSystem>>
Create the file at path with the given options. Then, open it with flag.
Parameters
- path: string
- flag: string
- mode: number
- options: CreationOptions
Returns Promise<File<FileSystem>>
Overrides Async(FileSystem).createFile
- Defined in src/backends/port/fs.ts:82

`Abstract`createFileSync

createFileSync(
    path: string,
    flag: string,
    mode: number,
    options: CreationOptions,
): File
Create the file at path with the given options. Then, open it with flag.
Parameters
- path: string
- flag: string
- mode: number
- options: CreationOptions
Returns File
Inherited from Async(FileSystem).createFileSync
- Defined in src/internal/filesystem.ts:283

exists

exists(path: string): Promise<boolean>
Test whether or not path exists.
Parameters
- path: string
Returns Promise<boolean>
Overrides Async(FileSystem).exists
- Defined in src/backends/port/fs.ts:102

existsSync

existsSync(path: string): boolean
Test whether or not path exists.
Parameters
- path: string
Returns boolean
Inherited from Async(FileSystem).existsSync
- Defined in src/internal/filesystem.ts:314

link

link(srcpath: string, dstpath: string): Promise<void>
Parameters
- srcpath: string
- dstpath: string
Returns Promise<void>
Overrides Async(FileSystem).link
- Defined in src/backends/port/fs.ts:106

`Abstract`linkSync

linkSync(target: string, link: string): void
Parameters
- target: string
- link: string
Returns void
Inherited from Async(FileSystem).linkSync
- Defined in src/internal/filesystem.ts:324

metadata

metadata(): FileSystemMetadata
Get metadata about the current file system

Returns FileSystemMetadata
Deprecated
Inherited from Async(FileSystem).metadata
- Defined in src/internal/filesystem.ts:240

mkdir

mkdir(path: string, mode: number, options: CreationOptions): Promise<void>
Parameters
- path: string
- mode: number
- options: CreationOptions
Returns Promise<void>
Overrides Async(FileSystem).mkdir
- Defined in src/backends/port/fs.ts:94

`Abstract`mkdirSync

mkdirSync(path: string, mode: number, options: CreationOptions): void
Parameters
- path: string
- mode: number
- options: CreationOptions
Returns void
Inherited from Async(FileSystem).mkdirSync
- Defined in src/internal/filesystem.ts:294

openFile

openFile(path: string, flag: string): Promise<File<FileSystem>>
Opens the file at path with flag. The file must exist.
Parameters
- path: string
  The path to open.
- flag: string
  The flag to use when opening the file.
Returns Promise<File<FileSystem>>
Overrides Async(FileSystem).openFile
- Defined in src/backends/port/fs.ts:78

`Abstract`openFileSync

openFileSync(path: string, flag: string): File
Opens the file at path with flag. The file must exist.
Parameters
- path: string
  The path to open.
- flag: string
  The flag to use when opening the file.
Returns File
Inherited from Async(FileSystem).openFileSync
- Defined in src/internal/filesystem.ts:273

queueDone

queueDone(): Promise<void>
Returns Promise<void>
Inherited from Async(FileSystem).queueDone
- Defined in src/mixins/async.ts:29

read

read(
    path: string,
    buffer: Uint8Array,
    offset: number,
    length: 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
  The offset into the file to start reading from
- length: number
Returns Promise<void>
Overrides Async(FileSystem).read
- Defined in src/backends/port/fs.ts:110

readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Overrides Async(FileSystem).readdir
- Defined in src/backends/port/fs.ts:98

`Abstract`readdirSync

readdirSync(path: string): string[]
Parameters
- path: string
Returns string[]
Inherited from Async(FileSystem).readdirSync
- Defined in src/internal/filesystem.ts:297

`Abstract`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
  The offset into the file to start reading from
- end: number
  The position in the file to stop reading
Returns void
Inherited from Async(FileSystem).readSync
- Defined in src/internal/filesystem.ts:342

ready

ready(): Promise<void>
Returns Promise<void>
Overrides Async(FileSystem).ready
- Defined in src/backends/port/fs.ts:60

rename

rename(oldPath: string, newPath: string): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Overrides Async(FileSystem).rename
- Defined in src/backends/port/fs.ts:65

`Abstract`renameSync

renameSync(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
Inherited from Async(FileSystem).renameSync
- Defined in src/internal/filesystem.ts:256

rmdir

rmdir(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides Async(FileSystem).rmdir
- Defined in src/backends/port/fs.ts:90

`Abstract`rmdirSync

rmdirSync(path: string): void
Parameters
- path: string
Returns void
Inherited from Async(FileSystem).rmdirSync
- Defined in src/internal/filesystem.ts:291

`Protected`rpc

rpc<
    const T extends
        | "link"
        | "sync"
        | "stat"
        | "write"
        | "read"
        | "rename"
        | "createFile"
        | "openFile"
        | "rmdir"
        | "mkdir"
        | "readdir"
        | "unlink"
        | "ready"
        | "exists"
        | "usage"
        | "metadata",
>(
    method: T,
    ...args: Parameters<
        ExtractProperties<
            FileSystem,
            (...args: any[]) => Promise<any> | UsageInfo,
        >[T],
    >,
): Promise<
    Awaited<
        ReturnType<
            ExtractProperties<
                FileSystem,
                (...args: any[]) => Promise<any> | UsageInfo,
            >[T],
        >,
    >,
>
Type Parameters
- const T extends
      | "link"
      | "sync"
      | "stat"
      | "write"
      | "read"
      | "rename"
      | "createFile"
      | "openFile"
      | "rmdir"
      | "mkdir"
      | "readdir"
      | "unlink"
      | "ready"
      | "exists"
      | "usage"
      | "metadata"
Parameters
- method: T
- ...args: Parameters<
      ExtractProperties<
          FileSystem,
          (...args: any[]) => Promise<any> | UsageInfo,
      >[T],
  >
Returns Promise<
    Awaited<
        ReturnType<
            ExtractProperties<
                FileSystem,
                (...args: any[]) => Promise<any> | UsageInfo,
            >[T],
        >,
    >,
>
- Defined in src/backends/port/fs.ts:53

stat

stat(path: string): Promise<Stats>
Parameters
- path: string
Returns Promise<Stats>
Overrides Async(FileSystem).stat
- Defined in src/backends/port/fs.ts:69

`Abstract`statSync

statSync(path: string): Stats
Parameters
- path: string
Returns Stats
Inherited from Async(FileSystem).statSync
- Defined in src/internal/filesystem.ts:259

streamRead

streamRead(path: string, options: StreamOptions): ReadableStream
Read a file using a stream.
Parameters
- path: string
- options: StreamOptions
Returns ReadableStream
Inherited from Async(FileSystem).streamRead
- Defined in src/internal/filesystem.ts:362

streamWrite

streamWrite(path: string, options: StreamOptions): WritableStream
Write a file using stream.
Parameters
- path: string
- options: StreamOptions
Returns WritableStream
Inherited from Async(FileSystem).streamWrite
- Defined in src/internal/filesystem.ts:385

sync

sync(
    path: string,
    data: undefined | Uint8Array<ArrayBufferLike>,
    stats: Readonly<InodeLike | Inode>,
): Promise<void>
Parameters
- path: string
- data: undefined | Uint8Array<ArrayBufferLike>
- stats: Readonly<InodeLike | Inode>
Returns Promise<void>
Overrides Async(FileSystem).sync
- Defined in src/backends/port/fs.ts:73

`Abstract`syncSync

syncSync(
    path: string,
    data?: Uint8Array<ArrayBufferLike>,
    stats?: Readonly<Partial<StatsLike<number | bigint>>>,
): void
Parameters
- path: string
- Optionaldata: Uint8Array<ArrayBufferLike>
- Optionalstats: Readonly<Partial<StatsLike<number | bigint>>>
Returns void
Inherited from Async(FileSystem).syncSync
- Defined in src/internal/filesystem.ts:327

toString

toString(): string
Returns string
Inherited from Async(FileSystem).toString
- Defined in src/internal/filesystem.ts:219

unlink

unlink(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides Async(FileSystem).unlink
- Defined in src/backends/port/fs.ts:86

`Abstract`unlinkSync

unlinkSync(path: string): void
Parameters
- path: string
Returns void
Inherited from Async(FileSystem).unlinkSync
- Defined in src/internal/filesystem.ts:286

usage

usage(): UsageInfo
Experimental
Default implementation.

Returns UsageInfo
Todo
Implement
Inherited from Async(FileSystem).usage
- Defined in src/internal/filesystem.ts:228

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(FileSystem).write
- Defined in src/backends/port/fs.ts:115

`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(FileSystem).writeSync
- Defined in src/internal/filesystem.ts:356

Class PortFS

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PortFS

Properties

Protected Optional Internal_mountPoint

Readonlyattributes

See

Readonlyid

Optionallabel

Readonlyname

Readonlyoptions

Readonlyport

Methods

createFile

Parameters

Returns Promise<File<FileSystem>>

AbstractcreateFileSync

Parameters

Returns File

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

link

Parameters

Returns Promise<void>

AbstractlinkSync

Parameters

Returns void

metadata

Returns FileSystemMetadata

Deprecated

mkdir

Parameters

Returns Promise<void>

AbstractmkdirSync

Parameters

Returns void

openFile

Parameters

Returns Promise<File<FileSystem>>

AbstractopenFileSync

Parameters

Returns File

queueDone

Returns Promise<void>

read

Parameters

Returns Promise<void>

readdir

Parameters

Returns Promise<string[]>

AbstractreaddirSync

Parameters

Returns string[]

AbstractreadSync

Parameters

Returns void

ready

Returns Promise<void>

rename

Parameters

Returns Promise<void>

AbstractrenameSync

Parameters

Returns void

rmdir

Parameters

Returns Promise<void>

AbstractrmdirSync

Parameters

`Protected` `Optional` `Internal`_mountPoint

`Readonly`attributes

`Readonly`id

`Optional`label

`Readonly`name

`Readonly`options

`Readonly`port

`Abstract`createFileSync

`Abstract`linkSync

`Abstract`mkdirSync

`Abstract`openFileSync

`Abstract`readdirSync

`Abstract`readSync

`Abstract`renameSync

`Abstract`rmdirSync

`Protected`rpc

Returns Promise<
Awaited<
ReturnType<
ExtractProperties<
FileSystem,
(...args: any[]) => Promise<any> | UsageInfo,
>[T],
>,
>,
>

`Abstract`statSync

`Abstract`syncSync

`Abstract`unlinkSync

`Abstract`writeSync