Interface ISteelClient

The minimal Steel service surface the import('./steel-remote-browser').SteelRemoteBrowser driver depends on. Production binds this to the real steel-sdk; tests inject a FakeSteelClient.

interface ISteelClient {
    CreateSession(
        options: SteelCreateSessionOptions,
    ): Promise<SteelSessionHandles>;
    ReleaseSession(sessionId: string): Promise<void>;
}

Index

Methods

CreateSession ReleaseSession

Methods

CreateSession

CreateSession(options: SteelCreateSessionOptions): Promise<SteelSessionHandles>
Creates a new Steel session and returns its id, CDP connect endpoint, and hosted session-viewer URL.
Parameters
- options: SteelCreateSessionOptions
  The session-creation options (opaque resolved configuration).
Returns Promise<SteelSessionHandles>
The created session's handles.
- Defined in Providers/Steel/src/steel-client.ts:72

ReleaseSession

ReleaseSession(sessionId: string): Promise<void>
Releases a Steel session, freeing the backing browser. Should be idempotent / non-throwing for an already-released session so teardown is safe to run more than once.
Parameters
- sessionId: string
  The Steel session id to release.
Returns Promise<void>
- Defined in Providers/Steel/src/steel-client.ts:80

Interface ISteelClient

Index

Methods

Methods

CreateSession

Parameters

Returns Promise<SteelSessionHandles>

ReleaseSession

Parameters

Returns Promise<void>

Settings

On This Page