Class RuntimeProvider

Base class shared by all TypeScript SDK provider implementations.

Hierarchy (View Summary)

ProviderBase
- RuntimeProvider

Constructors

constructor

new RuntimeProvider(options: RuntimeProviderOptions): RuntimeProvider
Parameters
- options: RuntimeProviderOptions
Returns RuntimeProvider
Overrides ProviderBase.constructor

Properties

name

name: string

`Readonly`displayName

displayName: string

`Readonly`description

description: string

`Readonly`version

version: string

`Readonly`kind

kind: "runtime" = ...

Methods

resolveName

resolveName(fallback: string): void
Parameters
- fallback: string
Returns void
Inherited from ProviderBase.resolveName

providerMetadata

providerMetadata(): ProviderMetadata
Returns ProviderMetadata
Inherited from ProviderBase.providerMetadata

configureProvider

configureProvider(name: string, config: Record<string, unknown>): Promise<void>
Parameters
- name: string
- config: Record<string, unknown>
Returns Promise<void>
Inherited from ProviderBase.configureProvider

supportsHealthCheck

supportsHealthCheck(): boolean
Returns boolean
Inherited from ProviderBase.supportsHealthCheck

healthCheck

healthCheck(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.healthCheck

startProvider

startProvider(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.startProvider

warnings

warnings(): Promise<string[]>
Returns Promise<string[]>
Inherited from ProviderBase.warnings

closeProvider

closeProvider(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.closeProvider

getSupport

getSupport(): Promise<RuntimeSupport>
Returns Promise<RuntimeSupport>

startSession

startSession(request: StartRuntimeSessionRequest): Promise<RuntimeSession>
Parameters
- request: StartRuntimeSessionRequest
Returns Promise<RuntimeSession>

getSession

getSession(request: GetRuntimeSessionRequest): Promise<RuntimeSession>
Parameters
- request: GetRuntimeSessionRequest
Returns Promise<RuntimeSession>

listSessions

listSessions(
request: ListRuntimeSessionsRequest,
): Promise<ListRuntimeSessionsResponse>
Parameters
- request: ListRuntimeSessionsRequest
Returns Promise<ListRuntimeSessionsResponse>

stopSession

stopSession(request: StopRuntimeSessionRequest): Promise<void>
Parameters
- request: StopRuntimeSessionRequest
Returns Promise<void>

prepareWorkspace

prepareWorkspace(
request: PrepareRuntimeWorkspaceRequest,
): Promise<PrepareRuntimeWorkspaceResponse>
Parameters
- request: PrepareRuntimeWorkspaceRequest
Returns Promise<PrepareRuntimeWorkspaceResponse>

removeWorkspace

removeWorkspace(request: RemoveRuntimeWorkspaceRequest): Promise<void>
Parameters
- request: RemoveRuntimeWorkspaceRequest
Returns Promise<void>

startApp

startApp(request: StartHostedAppRequest): Promise<HostedApp>
Parameters
- request: StartHostedAppRequest
Returns Promise<HostedApp>