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

Async & FileSystem<this>
- PortFS

Index

Constructors

constructor

Properties

_disableSync? options port

Constructors

constructor

new PortFS(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:154

Properties

`Protected` `Optional` `Internal`_disableSync

_disableSync?: boolean

Whether the sync cache should be disabled. Only affects async things.

`Readonly`options

options: Options

`Readonly`port

port: Port

Methods

createFile

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

createFileSync

createFileSync(path, flag, mode): File<FileSystem>
Parameters
- path: string
- flag: string
- mode: number
Returns File<FileSystem>
Inherited from Async(FileSystem).createFileSync
- Defined in src/mixins/async.ts:27

exists

exists(path): 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:219

existsSync

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

link

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

linkSync

linkSync(srcpath, dstpath): void
Parameters
- srcpath: string
- dstpath: string
Returns void
Inherited from Async(FileSystem).linkSync
- Defined in src/mixins/async.ts:33

metadata

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

Returns FileSystemMetadata
Overrides Async(FileSystem).metadata
- Defined in src/backends/port/fs.ts:160

mkdir

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

mkdirSync

mkdirSync(path, mode): void
Parameters
- path: string
- mode: number
Returns void
Inherited from Async(FileSystem).mkdirSync
- Defined in src/mixins/async.ts:31

openFile

openFile(path, flag): 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:195

openFileSync

openFileSync(path, flag): File<FileSystem>
Parameters
- path: string
- flag: string
Returns File<FileSystem>
Inherited from Async(FileSystem).openFileSync
- Defined in src/mixins/async.ts:28

queueDone

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

readdir

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

readdirSync

readdirSync(path): string[]
Parameters
- path: string
Returns string[]
Inherited from Async(FileSystem).readdirSync
- Defined in src/mixins/async.ts:32

ready

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

rename

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

renameSync

renameSync(oldPath, newPath): void
Parameters
- oldPath: string
- newPath: string
Returns void
Inherited from Async(FileSystem).renameSync
- Defined in src/mixins/async.ts:25

rmdir

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

rmdirSync

rmdirSync(path): void
Parameters
- path: string
Returns void
Inherited from Async(FileSystem).rmdirSync
- Defined in src/mixins/async.ts:30

`Protected`rpc

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

stat

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

statSync

statSync(path): Stats
Parameters
- path: string
Returns Stats
Inherited from Async(FileSystem).statSync
- Defined in src/mixins/async.ts:26

sync

sync(path, data, stats): Promise<void>
Parameters
- path: string
- data: Uint8Array
- stats: Readonly<Stats>
Returns Promise<void>
Overrides Async(FileSystem).sync
- Defined in src/backends/port/fs.ts:191

syncSync

syncSync(path, data, stats): void
Parameters
- path: string
- data: Uint8Array
- stats: Readonly<Stats>
Returns void
Inherited from Async(FileSystem).syncSync
- Defined in src/mixins/async.ts:34

unlink

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

unlinkSync

unlinkSync(path): void
Parameters
- path: string
Returns void
Inherited from Async(FileSystem).unlinkSync
- Defined in src/mixins/async.ts:29

Class PortFS

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PortFS

Properties

Protected Optional Internal_disableSync

Readonlyoptions

Readonlyport

Methods

createFile

Parameters

Returns Promise<File<FileSystem>>

createFileSync

Parameters

Returns File<FileSystem>

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

link

Parameters

Returns Promise<void>

linkSync

Parameters

Returns void

metadata

Returns FileSystemMetadata

mkdir

Parameters

Returns Promise<void>

mkdirSync

Parameters

Returns void

openFile

Parameters

Returns Promise<File<FileSystem>>

openFileSync

Parameters

Returns File<FileSystem>

queueDone

Returns Promise<void>

readdir

Parameters

Returns Promise<string[]>

readdirSync

Parameters

Returns string[]

ready

Returns Promise<void>

rename

Parameters

Returns Promise<void>

renameSync

Parameters

Returns void

rmdir

Parameters

Returns Promise<void>

rmdirSync

Parameters

Returns void

Protectedrpc

Type Parameters

Parameters

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

stat

Parameters

Returns Promise<Stats>

statSync

Parameters

Returns Stats

sync

`Protected` `Optional` `Internal`_disableSync

`Readonly`options

`Readonly`port

`Protected`rpc