electron-agent-bridge
    Preparing search index...

    A Chrome DevTools Protocol connection to one page. v1 ships the in-process webContents.debugger adapter; a WebSocket adapter is additive (v1.1).

    interface CdpTransport {
        attached: boolean;
        detachedReason:
            | "unknown"
            | "host-debugger"
            | "target-closed"
            | "crashed"
            | "closed"
            | undefined;
        kind: "in-process"
        | "websocket";
        close(): Promise<void>;
        onAttach(listener: () => void): Disposable;
        onDetach(
            listener: (
                reason:
                    | "unknown"
                    | "host-debugger"
                    | "target-closed"
                    | "crashed"
                    | "closed",
            ) => void,
        ): Disposable;
        onEvent(listener: (event: CdpEvent) => void): Disposable;
        post(method: string, params?: object, sessionId?: string): void;
        send(method: string, params?: object, sessionId?: string): Promise<unknown>;
    }

    Implemented by

    Index
    attached: boolean
    detachedReason:
        | "unknown"
        | "host-debugger"
        | "target-closed"
        | "crashed"
        | "closed"
        | undefined

    Why the transport is detached; undefined while attached.

    kind: "in-process" | "websocket"
    • The transport (re)attached: a fresh CDP session, so anything set up on the previous one (enabled domains, scripts to evaluate on new documents) must be set up again.

      Parameters

      • listener: () => void

      Returns Disposable

    • Parameters

      • listener: (
            reason:
                | "unknown"
                | "host-debugger"
                | "target-closed"
                | "crashed"
                | "closed",
        ) => void

      Returns Disposable

    post

    • post(method: string, params?: object, sessionId?: string): void

      Send a command without awaiting it. Required before a page's first navigation, where commands may not resolve until navigation starts (ADR-0002). Failures are swallowed.

      Parameters

      • method: string
      • Optionalparams: object
      • OptionalsessionId: string

      Returns void

    • Send a command and await its result. Rejects with a BridgeError.

      Parameters

      • method: string
      • Optionalparams: object
      • OptionalsessionId: string

      Returns Promise<unknown>