Class RemoteFolio

Readonlyinfo

[asyncDispose]

• "[asyncDispose]"(): Promise<void>

  await using support; equivalent to close().

  Returns Promise<void>

close

• close(): Promise<void>

  Ends the session; the host joins its workers before releasing the slot.

  Returns Promise<void>

read

• read(
      offset: number,
      length: number,
      memory?: string,
  ): Promise<Uint8Array<ArrayBufferLike>>

  Reads bytes from the host's memory, bounded by the host's read limit.

  Parameters

  • offset: number
  • length: number
  • Optionalmemory: string

  Returns Promise<Uint8Array<ArrayBufferLike>>

retryPending

• retryPending(): Promise<any>

  Resends the exact uncertain request; the host returns its cached result without repeating effects.

  Returns Promise<any>

run

• run(
      entry: string,
      args?: readonly unknown[],
      options?: {
          maximumWorkers?: number;
          parallel?: "auto" | "off" | "speculate";
      },
  ): Promise<RemoteReport>

  Runs one allowlisted export in order on the host.

  Parameters

  • entry: string
  • args: readonly unknown[] = []
  • options: { maximumWorkers?: number; parallel?: "auto" | "off" | "speculate" } = {}

  Returns Promise<RemoteReport>

write

• write(offset: number, bytes: Uint8Array, memory?: string): Promise<void>

  Writes bytes into the host's memory, bounded by the host's write limit.

  Parameters

  • offset: number
  • bytes: Uint8Array
  • Optionalmemory: string

  Returns Promise<void>

Staticopen

• open(
      url: string | URL,
      artifact: string,
      options?: RemoteOptions & { workers?: number },
  ): Promise<RemoteFolio>

  Opens a session on a registered artifact; workers asks for a group width within host limits.

  Parameters

  • url: string | URL
  • artifact: string
  • options: RemoteOptions & { workers?: number } = {}

  Returns Promise<RemoteFolio>