electron-agent-bridge
    Preparing search index...

    Options an app passes to enableAgentBridge.

    interface BridgeOptions {
        allowPackaged?: boolean;
        audit?: string | false;
        capabilities?: readonly ("observe" | "interact" | "eval")[];
        ipc?: { values?: readonly string[] };
        logs?: {
            mainConsole?: boolean;
            sourceMaps?: boolean;
            sources?: readonly LogSource[];
        };
        snapshot?: { clickListeners?: boolean };
        state?: { devtoolsShim?: boolean };
    }
    Index
    allowPackaged?: boolean

    Allow the bridge in a packaged app (still requires EAB_ENABLE=1). Default false.

    audit?: string | false

    Audit log of calls (metadata only). Default: <endpoint dir>/audit-<pid>.jsonl. A path writes there instead; false turns it off (and wins over EAB_AUDIT).

    capabilities?: readonly ("observe" | "interact" | "eval")[]

    Highest capability any client may get. Default ['observe', 'interact']; eval is opt-in.

    ipc?: { values?: readonly string[] }

    IPC capture. Arguments are recorded as shapes only; values lists channel globs (e.g. ['settings:*']) whose argument values are recorded too, with secret-looking keys redacted.

    logs?: {
        mainConsole?: boolean;
        sourceMaps?: boolean;
        sources?: readonly LogSource[];
    }

    Logs. The main process's console is recorded unless mainConsole is false; sources adds the app's own loggers (see loggerSource, or addLogSource at any time).

    Type Declaration

    • Optional ReadonlymainConsole?: boolean
    • Optional ReadonlysourceMaps?: boolean

      Map stack frames to original sources through the scripts' source maps when logs are read. Default on.

    • Optional Readonlysources?: readonly LogSource[]
    snapshot?: { clickListeners?: boolean }

    Snapshots. clickListeners: false stops the main-world hook from noting which elements get click listeners (it wraps EventTarget.prototype.addEventListener, recording and delegating), so plain elements the page listens to no longer get a clickable ref. Default on.

    state?: { devtoolsShim?: boolean }

    State. devtoolsShim: true defines the Redux DevTools extension globals in app pages (when no real extension is there), so stores built with devtools support register themselves. Default off: registerState from @electron-agent-bridge/electron/renderer needs no shim.