api / classes / RuntimeContainer

Class: RuntimeContainer

Properties

Property	Modifier	Type	Default value
`capabilities`	`readonly`	`RuntimeCapabilities`	`undefined`
`fs`	`readonly`	`RemoteVfs`	`undefined`
`tabId`	`readonly`	`string`	`undefined`
`workdir`	`readonly`	`"/workdir"`	`'/workdir'`

Methods

emitDiagnostic()

emitDiagnostic(diagnostic, level?): void;

Parameters

Parameter	Type	Default value
`diagnostic`	`RuntimeDiagnostic`	`undefined`
`level`	`RuntimeDiagnosticLevel`	`'info'`

Returns

void

enablePreviewReloadBridge()

enablePreviewReloadBridge(): Promise<void>;

Returns

Promise<void>

fetchPreview()

fetchPreview(
   port, 
   path?, 
   options?): Promise<{
  body: string;
  headers: Readonly<Record<string, string>>;
  status: number;
}>;

Parameters

Parameter	Type	Default value
`port`	`number`	`undefined`
`path`	`string`	`'/'`
`options`	`PreviewFetchOptions`	`{}`

Returns

Promise<{ body: string; headers: Readonly<Record<string, string>>; status: number; }>

fetchPreviewStream()

fetchPreviewStream(
   port, 
   path?, 
   options?): Promise<{
  body: ReadableStream<Uint8Array<ArrayBufferLike>>;
  headers: Readonly<Record<string, string>>;
  status: number;
}>;

Parameters

Parameter	Type	Default value
`port`	`number`	`undefined`
`path`	`string`	`'/'`
`options`	`PreviewFetchOptions`	`{}`

Returns

Promise<{ body: ReadableStream<Uint8Array<ArrayBufferLike>>; headers: Readonly<Record<string, string>>; status: number; }>

getDiagnostics()

getDiagnostics(): RuntimeDiagnosticsSnapshot;

Returns

RuntimeDiagnosticsSnapshot

mount()

mount(tree): Promise<void>;

Parameters

Parameter	Type
`tree`	`FileSystemTree`

Returns

Promise<void>

on()

on<K>(event, listener): () => void;

Type Parameters

Type Parameter
`K` extends keyof `RuntimeEventMap`

Parameters

Parameter	Type
`event`	`K`
`listener`	(`value`) => `void`

Returns

() => void

persist()

persist(): Promise<void>;

Returns

Promise<void>

setPreviewScript()

setPreviewScript(script): Promise<void>;

Parameters

Parameter	Type
`script`	`string`

Returns

Promise<void>

spawn()

spawn(
   command, 
   args?, 
options?): Promise<RuntimeProcess>;

Parameters

Parameter	Type	Default value
`command`	`string`	`undefined`
`args`	readonly `string`[]	`[]`
`options`	`SpawnOptions`	`{}`

Returns

Promise<RuntimeProcess>

storageEstimate()

storageEstimate(): Promise<RuntimeStorageEstimate>;

Returns

Promise<RuntimeStorageEstimate>

teardown()

teardown(): Promise<void>;

Returns

Promise<void>

boot()

static boot(rawOptions): Promise<RuntimeContainer>;

Parameters

Parameter	Type
`rawOptions`	`BootOptions`

Returns

Promise<RuntimeContainer>

clearPersistence()

static clearPersistence(persistenceKey): Promise<boolean>;

Parameters

Parameter	Type
`persistenceKey`	`string`

Returns

Promise<boolean>