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

Constructors

constructor

Properties

_disableSync? options port

Methods

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

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

Properties

Protected Optional Internal_disableSync

_disableSync?: boolean

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

Readonlyoptions

options: Options

Readonlyport

port: Port

Methods

createFile

AbstractcreateFileSync

exists

  • exists(path: string): Promise<boolean>

  • Test whether or not path exists.

    Parameters

    • path: string

    Returns Promise<boolean>

existsSync

  • existsSync(path: string): boolean

  • Test whether or not path exists.

    Parameters

    • path: string

    Returns boolean

link

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

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns Promise<void>

AbstractlinkSync

  • linkSync(target: string, link: string): void

  • Parameters

    • target: string
    • link: string

    Returns void

metadata

mkdir

AbstractmkdirSync

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

AbstractopenFileSync

  • openFileSync(path: string, flag: string): 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 File<FileSystem>

queueDone

  • queueDone(): Promise<void>

  • Returns Promise<void>

read

  • read(
        path: string,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
        length: number,
    ): Promise<void>

  • Reads into a buffer

    Parameters

    • path: string
    • buffer: Uint8Array<ArrayBufferLike>

      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>

readdir

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

  • Parameters

    • path: string

    Returns Promise<string[]>

AbstractreaddirSync

  • readdirSync(path: string): string[]

  • Parameters

    • path: string

    Returns string[]

AbstractreadSync

  • readSync(
        path: string,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
        end: number,
    ): void

  • Reads into a buffer

    Parameters

    • path: string
    • buffer: Uint8Array<ArrayBufferLike>

      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

ready

rename

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

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

AbstractrenameSync

  • renameSync(oldPath: string, newPath: string): void

  • Parameters

    • oldPath: string
    • newPath: string

    Returns void

rmdir

  • rmdir(path: string): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

AbstractrmdirSync

  • rmdirSync(path: string): void

  • Parameters

    • path: string

    Returns void

Protectedrpc

  • rpc<
        const T extends
            | "link"
            | "write"
            | "rename"
            | "stat"
            | "createFile"
            | "openFile"
            | "unlink"
            | "rmdir"
            | "mkdir"
            | "readdir"
            | "sync"
            | "read"
            | "ready"
            | "exists"
            | "metadata",
    >(
        method: T,
        ...args: Parameters<
            ExtractProperties<
                FileSystem,
                (...args: any[]) => Promise<any> | FileSystemMetadata,
            >[T],
        >,
    ): Promise<
        Awaited<
            ReturnType<
                ExtractProperties<
                    FileSystem,
                    (...args: any[]) => Promise<any> | FileSystemMetadata,
                >[T],
            >,
        >,
    >

  • Type Parameters

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

    Parameters

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

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

stat

AbstractstatSync

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>

AbstractsyncSync

  • 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

unlink

  • unlink(path: string): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

AbstractunlinkSync

  • unlinkSync(path: string): void

  • Parameters

    • path: string

    Returns void

write

  • write(
        path: string,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
    ): Promise<void>

  • Writes a buffer to a file

    Parameters

    • path: string
    • buffer: Uint8Array<ArrayBufferLike>

      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>

AbstractwriteSync

  • writeSync(
        path: string,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
    ): void

  • Writes a buffer to a file

    Parameters

    • path: string
    • buffer: Uint8Array<ArrayBufferLike>

      The buffer to write. You must set the byteOffset and byteLength appropriately!

    • offset: number

      The offset in the file to start writing

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods