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.

Extends

AsyncMixin<this> & FileSystem<this>

Type Parameters

T

T extends Channel = Channel

Constructors

Constructor

new PortFS<T>(channel, timeout?): PortFS<T>

Defined in: src/backends/port.ts:50

Constructs a new PortFS instance that connects with the FS running on options.port.

Parameters

channel

T

timeout?

number = 250

Returns

PortFS<T>

Overrides

Async(FileSystem).constructor

Properties

_mountPoint?

protected optional _mountPoint?: string

Defined in: src/internal/filesystem.ts:162

Internal

The last place this file system was mounted

Inherited from

Async(FileSystem)._mountPoint

_uuid

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

Defined in: src/internal/filesystem.ts:169

Internal

The UUID of the file system.

Inherited from

Async(FileSystem)._uuid

attributes

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

Defined in: src/internal/filesystem.ts:178

See

FileSystemAttributes

Inherited from

Async(FileSystem).attributes

channel

readonly channel: T

Defined in: src/backends/port.ts:51

label?

optional label?: string

Defined in: src/internal/filesystem.ts:156

Inherited from

Async(FileSystem).label

name

readonly name: string

Defined in: src/internal/filesystem.ts:191

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

Inherited from

Async(FileSystem).name

port

readonly port: Port<T>

Defined in: src/backends/port.ts:40

timeout

readonly timeout: number = 250

Defined in: src/backends/port.ts:52

type

readonly type: number

Defined in: src/internal/filesystem.ts:185

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

Inherited from

Async(FileSystem).type

Accessors

uuid

Get Signature

get uuid(): `${string}-${string}-${string}-${string}-${string}`

Defined in: src/internal/filesystem.ts:171

Returns

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

Inherited from

Async(FileSystem).uuid

Methods

createFile()

createFile(path, options): Promise<Inode>

Defined in: src/backends/port.ts:91

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Promise<Inode>

Overrides

Async(FileSystem).createFile

createFileSync()

abstract createFileSync(path, options): InodeLike

Defined in: src/internal/filesystem.ts:238

Create the file at path with the given options.

Parameters

path

string

exists()

exists(path): Promise<boolean>

Defined in: src/backends/port.ts:115

Test whether or not path exists.

Parameters

path

string

Returns

Promise<boolean>

Overrides

Async(FileSystem).exists

existsSync()

existsSync(path): boolean

Defined in: src/internal/filesystem.ts:269

Test whether or not path exists.

Parameters

path

string

Returns

boolean

Inherited from

Async(FileSystem).existsSync

ioctl()

ioctl(context, command, …args): Promise<any>

Defined in: src/internal/filesystem.ts:359

Internal

Parameters

context

IoctlContext

command

number

args

…any[]

Returns

Promise<any>

Inherited from

Async(FileSystem).ioctl

ioctlSync()

ioctlSync(context, command, …args): any

Defined in: src/internal/filesystem.ts:367

Internal

Parameters

context

IoctlContext

command

number

args

…any[]

Returns

any

Inherited from

FileSystem.ioctlSync

link()

link(srcpath, dstpath): Promise<void>

Defined in: src/backends/port.ts:119

Parameters

srcpath

string

dstpath

string

Returns

Promise<void>

Overrides

Async(FileSystem).link

linkSync()

abstract linkSync(target, link): void

Defined in: src/internal/filesystem.ts:279

Parameters

target

string

link

string

Returns

void

Inherited from

FileSystem.linkSync

mkdir()

mkdir(path, options): Promise<Inode>

Defined in: src/backends/port.ts:105

Parameters

path

string

options

CreationOptions

Returns

Promise<Inode>

Overrides

Async(FileSystem).mkdir

mkdirSync()

abstract mkdirSync(path, options): InodeLike

Defined in: src/internal/filesystem.ts:249

Parameters

path

string

options

CreationOptions

Returns

InodeLike

Inherited from

FileSystem.mkdirSync

queueDone()

queueDone(): Promise<void>

Defined in: src/mixins/async.ts:31

Returns

Promise<void>

Inherited from

Async(FileSystem).queueDone

read()

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

Defined in: src/backends/port.ts:123

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

readdir()

readdir(path): Promise<string[]>

Defined in: src/backends/port.ts:111

Parameters

path

string

Returns

Promise<string[]>

Overrides

Async(FileSystem).readdir

readdirSync()

abstract readdirSync(path): string[]

Defined in: src/internal/filesystem.ts:252

Parameters

path

string

Returns

string[]

Inherited from

FileSystem.readdirSync

readSync()

abstract readSync(path, buffer, start, end): void

Defined in: src/internal/filesystem.ts:297

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

FileSystem.readSync

ready()

ready(): Promise<void>

Defined in: src/backends/port.ts:67

Returns

Promise<void>

Overrides

AsyncMixin.ready

readySync()

readySync(): void

Defined in: src/internal/filesystem.ts:214

Returns

void

Inherited from

FileSystem.readySync

rename()

rename(oldPath, newPath): Promise<void>

Defined in: src/backends/port.ts:72

Parameters

oldPath

string

newPath

string

Returns

Promise<void>

Overrides

Async(FileSystem).rename

renameSync()

abstract renameSync(oldPath, newPath): void

Defined in: src/internal/filesystem.ts:219

Parameters

oldPath

string

newPath

string

Returns

void

Inherited from

FileSystem.renameSync

rmdir()

rmdir(path): Promise<void>

Defined in: src/backends/port.ts:101

Parameters

path

string

Returns

Promise<void>

Overrides

Async(FileSystem).rmdir

rmdirSync()

abstract rmdirSync(path): void

Defined in: src/internal/filesystem.ts:246

Parameters

path

string

Returns

void

Inherited from

FileSystem.rmdirSync

rpc()

protected rpc<T>(method, …args): Promise<Awaited<ReturnType<Methods[T]>>>

Defined in: src/backends/port.ts:59

Type Parameters

T

T extends keyof Methods

Parameters

method

T

args

…Parameters<Methods[T]>

Returns

Promise<Awaited<ReturnType<Methods[T]>>>

stat()

stat(path): Promise<Inode>

Defined in: src/backends/port.ts:76

Parameters

path

string

Returns

Promise<Inode>

Overrides

Async(FileSystem).stat

statSync()

abstract statSync(path): InodeLike

Defined in: src/internal/filesystem.ts:222

Parameters

path

string

Returns

InodeLike

Inherited from

FileSystem.statSync

streamRead()

streamRead(path, options): ReadableStream

Defined in: src/internal/filesystem.ts:317

Read a file using a stream.

Parameters

path

string

options

StreamOptions

Returns

ReadableStream

Inherited from

Async(FileSystem).streamRead

streamWrite()

streamWrite(path, options): WritableStream

Defined in: src/internal/filesystem.ts:340

Write a file using stream.

Parameters

path

string

options

StreamOptions

Returns

WritableStream

Inherited from

Async(FileSystem).streamWrite

sync()

sync(): Promise<void>

Defined in: src/backends/port.ts:86

Returns

Promise<void>

Overrides

AsyncMixin.sync

syncSync()

abstract syncSync(): void

Defined in: src/internal/filesystem.ts:282

Returns

void

Inherited from

FileSystem.syncSync

toString()

toString(): string

Defined in: src/internal/filesystem.ts:197

Returns

string

Inherited from

Async(FileSystem).toString

touch()

touch(path, metadata): Promise<void>

Defined in: src/backends/port.ts:81

Modify metadata.

Parameters

path

string

metadata

InodeLike<number> | Inode

Returns

Promise<void>

Overrides

Async(FileSystem).touch

touchSync()

abstract touchSync(path, metadata): void

Defined in: src/internal/filesystem.ts:228

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

void

Inherited from

FileSystem.touchSync

unlink()

unlink(path): Promise<void>

Defined in: src/backends/port.ts:97

Parameters

path

string

Returns

Promise<void>

Overrides

Async(FileSystem).unlink

unlinkSync()

abstract unlinkSync(path): void

Defined in: src/internal/filesystem.ts:241

Parameters

path

string

Returns

void

Inherited from

FileSystem.unlinkSync

usage()

usage(): UsageInfo

Defined in: src/internal/filesystem.ts:206

Default implementation.

Returns

UsageInfo

Todo

Implement

Inherited from

Async(FileSystem).usage

write()

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

Defined in: src/backends/port.ts:127

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

writeSync()

abstract writeSync(path, buffer, offset): void

Defined in: src/internal/filesystem.ts:311

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

FileSystem.writeSync

Contribute Sponsor