Class PortFS`Internal`

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: PortOptions): PortFS
Constructs a new PortFS instance that connects with the FS running on options.port.
Parameters
- options: PortOptions
Returns PortFS
Overrides Async(FileSystem).constructor
- Defined in src/backends/port.ts:256

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`options

options: PortOptions

`Readonly`port

port: RPCPort

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

Methods

createFile

createFile(path: string, options: CreationOptions): Promise<Inode>
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns Promise<Inode>
Overrides Async(FileSystem).createFile
- Defined in src/backends/port.ts:295

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

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.ts:319

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

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.ts:323

`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:270

mkdir

mkdir(path: string, options: CreationOptions): Promise<Inode>
Parameters
- path: string
- options: CreationOptions
Returns Promise<Inode>
Overrides Async(FileSystem).mkdir
- Defined in src/backends/port.ts:309

`Abstract`mkdirSync

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

queueDone

queueDone(): Promise<void>
Returns Promise<void>
Deprecated
Use sync instead
Inherited from Async(FileSystem).queueDone
- Defined in src/mixins/async.ts:30

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>
Overrides Async(FileSystem).read
- Defined in src/backends/port.ts:327

readdir

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

`Abstract`readdirSync

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

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

ready

ready(): Promise<void>
Returns Promise<void>
Deprecated
Use sync instead
Overrides Async(FileSystem).ready
- Defined in src/backends/port.ts:269

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.ts:274

`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:210

rmdir

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

`Abstract`rmdirSync

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

`Protected`rpc

rpc<const T extends keyof RPCMethods>(
method: T,
...args: Parameters<RPCMethods[T]>,
): Promise<Awaited<ReturnType<RPCMethods[T]>>>
Type Parameters
- const T extends keyof RPCMethods
Parameters
- method: T
- ...args: Parameters<RPCMethods[T]>
Returns Promise<Awaited<ReturnType<RPCMethods[T]>>>
- Defined in src/backends/port.ts:262

stat

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

`Abstract`statSync

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

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

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

sync

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

`Abstract`syncSync

syncSync(): void
Returns void
Inherited from Async(FileSystem).syncSync
- Defined in src/internal/filesystem.ts:273

toString

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

touch

touch(path: string, metadata: InodeLike | Inode): Promise<void>
Modify metadata.
Parameters
- path: string
- metadata: InodeLike | Inode
Returns Promise<void>
Overrides Async(FileSystem).touch
- Defined in src/backends/port.ts:283

`Abstract`touchSync

touchSync(path: string, metadata: Partial<InodeLike>): void
Modify metadata.
Parameters
- path: string
- metadata: Partial<InodeLike>
Returns void
Inherited from Async(FileSystem).touchSync
- 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.ts:301

`Abstract`unlinkSync

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

usage

usage(): UsageInfo
Experimental
Default implementation.

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

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.ts:331

`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:302

Class PortFSInternal

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PortFS

Properties

Protected Optional Internal_mountPoint

Protected Internal_uuid

Readonlyattributes

See

Optionallabel

Readonlyname

Readonlyoptions

Readonlyport

Readonlytype

Accessors

uuid

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

Methods

createFile

Parameters

Returns Promise<Inode>

AbstractcreateFileSync

Parameters

Returns InodeLike

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

link

Parameters

Returns Promise<void>

AbstractlinkSync

Parameters

Returns void

mkdir

Parameters

Returns Promise<Inode>

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

rename

Parameters

Returns Promise<void>

AbstractrenameSync

Parameters

Returns void

rmdir

Parameters

Returns Promise<void>

AbstractrmdirSync

Parameters

Returns void

Protectedrpc

Class PortFS`Internal`

`Protected` `Optional` `Internal`_mountPoint

`Protected` `Internal`_uuid

`Readonly`attributes

`Optional`label

`Readonly`name

`Readonly`options

`Readonly`port

`Readonly`type

`Abstract`createFileSync

`Abstract`linkSync

`Abstract`mkdirSync

`Abstract`readdirSync

`Abstract`readSync

`Abstract`renameSync

`Abstract`rmdirSync

`Protected`rpc

`Abstract`statSync

`Abstract`syncSync

`Abstract`touchSync

`Abstract`unlinkSync

`Abstract`writeSync