Class SidecarContainer

ReadonlycontainerId

ReadonlycontainerName

filesystem

• get filesystem(): SandboxFilesystem

  Namespace for filesystem APIs scoped to this sidecar container.

  Returns SandboxFilesystem

exec

• exec(
      command: string[],
      params?: SandboxExecParams & { mode?: "text" },
  ): Promise<ContainerProcess<string>>

  Parameters

  • command: string[]
  • Optionalparams: SandboxExecParams & { mode?: "text" }

  Returns Promise<ContainerProcess<string>>

• exec(
      command: string[],
      params: SandboxExecParams & { mode: "binary" },
  ): Promise<ContainerProcess<Uint8Array<ArrayBufferLike>>>

  Parameters

  • command: string[]
  • params: SandboxExecParams & { mode: "binary" }

  Returns Promise<ContainerProcess<Uint8Array<ArrayBufferLike>>>

poll

• poll(): Promise<null | number>

  Check if the sidecar container has finished running.

  Returns null if the container is still running, else the exit code.

  Returns Promise<null | number>

terminate

• terminate(): Promise<void>

  Returns Promise<void>

• terminate(params: { wait: true }): Promise<number>

  Parameters

  • params: { wait: true }

  Returns Promise<number>

wait

• wait(): Promise<number>

  Block until the sidecar container exits, and return its exit code.

  Returns Promise<number>