Interface WasmerShellSession

Managed byte streams and lifecycle for a running Wasmer shell.

interface WasmerShellSession {
    capabilities: WasmerShellCapabilities;
    error: Error | undefined;
    exit: Promise<WasmerProcessOutput>;
    status: WasmerShellStatus;
    transport: TerminalTransport;
    close(): Promise<WasmerProcessOutput>;
    dispose(): void;
    onStatusChange(listener: (status: WasmerShellStatus) => void): Disposable;
}

Hierarchy (View Summary)

Disposable
- WasmerShellSession

Index

Properties

capabilities error exit status transport

Methods

close dispose onStatusChange

Properties

`Readonly`capabilities

capabilities: WasmerShellCapabilities

Process capabilities that integrations may feature-detect.

`Readonly`error

error: Error | undefined

Failure that moved the session into the error state.

`Readonly`exit

exit: Promise<WasmerProcessOutput>

Resolves with captured output and status when the process exits.

`Readonly`status

status: WasmerShellStatus

Current lifecycle state.

`Readonly`transport

transport: TerminalTransport

Terminal-compatible byte streams. They may be connected once.

Methods

close

close(): Promise<WasmerProcessOutput>
Closes stdin and waits for the process to exit.

Returns Promise<WasmerProcessOutput>
- Defined in packages/wasmer/src/types.ts:215

dispose

dispose(): void
Releases the resource. Safe implementations should be idempotent.

Returns void
Inherited from Disposable.dispose
- Defined in packages/core/src/core/types.ts:632

onStatusChange

onStatusChange(listener: (status: WasmerShellStatus) => void): Disposable
Subscribes to lifecycle transitions.
Parameters
- listener: (status: WasmerShellStatus) => void
Returns Disposable
- Defined in packages/wasmer/src/types.ts:217