Class PortFS

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

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

Hierarchy

  • {
        _sync?: FileSystem;
        createFileSync(path, flag, mode): File;
        linkSync(srcpath, dstpath): void;
        mkdirSync(path, mode): void;
        openFileSync(path, flag): File;
        queueDone(): Promise<void>;
        readdirSync(path): string[];
        ready(): Promise<void>;
        renameSync(oldPath, newPath): void;
        rmdirSync(path): void;
        statSync(path): Stats;
        syncSync(path, data, stats): void;
        unlinkSync(path): void;
    } & FileSystem<this>
    • PortFS

Constructors

constructor

Properties

_disableSync? options port

Methods

createFile createFileSync exists existsSync link linkSync metadata mkdir mkdirSync openFile openFileSync queueDone readdir readdirSync ready rename renameSync rmdir rmdirSync rpc stat statSync sync syncSync unlink unlinkSync

Constructors

constructor

  • new PortFS(options): PortFS

  • Constructs a new PortFS instance that connects with ZenFS running on the specified port.

    Parameters

    • options: Options

    Returns PortFS

Properties

Optional Protected 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>

  • Parameters

    • path: string
    • flag: string
    • mode: number

    Returns Promise<File>

createFileSync

  • createFileSync(path, flag, mode): File

  • Parameters

    • path: string
    • flag: string
    • mode: number

    Returns File

exists

  • exists(path): Promise<boolean>

  • Parameters

    • path: string

    Returns Promise<boolean>

existsSync

  • existsSync(path): boolean

  • Test whether or not the given path exists.

    Parameters

    • path: string

    Returns boolean

link

  • link(srcpath, dstpath): Promise<void>

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns Promise<void>

linkSync

  • linkSync(srcpath, dstpath): void

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns void

metadata

mkdir

  • mkdir(path, mode): Promise<void>

  • Parameters

    • path: string
    • mode: number

    Returns Promise<void>

mkdirSync

  • mkdirSync(path, mode): void

  • Parameters

    • path: string
    • mode: number

    Returns void

openFile

openFileSync

  • openFileSync(path, flag): File

  • Parameters

    • path: string
    • flag: string

    Returns File

queueDone

  • queueDone(): Promise<void>

  • Returns Promise<void>

readdir

  • readdir(path): Promise<string[]>

  • Parameters

    • path: string

    Returns Promise<string[]>

readdirSync

  • readdirSync(path): string[]

  • Parameters

    • path: string

    Returns string[]

ready

rename

  • rename(oldPath, newPath): Promise<void>

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

renameSync

  • renameSync(oldPath, newPath): void

  • Parameters

    • oldPath: string
    • newPath: string

    Returns void

rmdir

  • rmdir(path): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

rmdirSync

  • rmdirSync(path): void

  • Parameters

    • path: string

    Returns void

Protected rpc

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

  • Type Parameters

    • const T extends "link" | "ready" | "rename" | "stat" | "openFile" | "rmdir" | "unlink" | "mkdir" | "readdir" | "sync" | "metadata" | "createFile" | "exists"

    Parameters

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

stat

statSync

sync

  • sync(path, data, stats): Promise<void>

  • Parameters

    • path: string
    • data: Uint8Array
    • stats: Readonly<Stats>

    Returns Promise<void>

syncSync

  • syncSync(path, data, stats): void

  • Parameters

    • path: string
    • data: Uint8Array
    • stats: Readonly<Stats>

    Returns void

unlink

  • unlink(path): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

unlinkSync

  • unlinkSync(path): void

  • Parameters

    • path: string

    Returns void

Settings

Member Visibility

Theme

On This Page

constructor_disableSyncoptionsportcreateFilecreateFileSyncexistsexistsSynclinklinkSyncmetadatamkdirmkdirSyncopenFileopenFileSyncqueueDonereaddirreaddirSyncreadyrenamerenameSyncrmdirrmdirSyncrpcstatstatSyncsyncsyncSyncunlinkunlinkSync