For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/cdp/api-ref/global-props.md.
Lynx
  • English
  • GlobalProps

    This page documents the GlobalProps CDP domain supported by Lynx DevTool.

    Experimental reference

    This generated reference is still being completed.

    • CDP events are not included yet.
    • Some Lynx extensions are listed but do not yet have detailed documentation.
    • Method descriptions are not automatically verified against the implementation and may be incomplete or inaccurate.

    Verify behavior against the implementation and the linked upstream CDP reference before relying on it.

    Overview

    • Scope: instance
    • CDP domain: Lynx-specific

    Lynx Extensions

    GlobalProps.disable

    Disables GlobalProps change events for the current Lynx target.

    • Origin: lynx-extension
    • Source: devtool/lynx_devtool/agent/domain_agent/inspector_global_props_agent.cc
    Parameters

    No parameters.

    Returns

    No return fields.

    Notes
    • Dispatches through LynxDevToolMediator to InspectorTasmExecutor on the TASM task runner.
    • The operation is idempotent and returns an empty result object.
    • GlobalProps.get and replace remain available after events are disabled.
    • Returns a CDP error with code -32000 when the TASM target is unavailable.
    Examples

    Disable GlobalProps inspection

    Request:

    {
      "id": 1,
      "method": "GlobalProps.disable"
    }

    Response:

    {
      "id": 1,
      "result": {}
    }

    GlobalProps.enable

    Enables GlobalProps change events for the current Lynx target.

    • Origin: lynx-extension
    • Source: devtool/lynx_devtool/agent/domain_agent/inspector_global_props_agent.cc
    Parameters

    No parameters.

    Returns

    No return fields.

    Events
    • GlobalProps.changed: Emitted for each authoritative update with a backend-generated timestamp and a single replace item. Call GlobalProps.get to read the complete current value.
    Notes
    • Dispatches through LynxDevToolMediator to InspectorTasmExecutor on the TASM task runner.
    • The operation is idempotent and returns an empty result object.
    • Call GlobalProps.get after enabling to obtain the initial value and its timestamp; updates that happened before enable are not replayed.
    • Returns a CDP error with code -32000 when the TASM target is unavailable.
    Examples

    Enable GlobalProps inspection

    Request:

    {
      "id": 1,
      "method": "GlobalProps.enable"
    }

    Response:

    {
      "id": 1,
      "result": {}
    }

    GlobalProps.get

    Returns the complete authoritative GlobalProps object for the current Lynx target.

    • Origin: lynx-extension
    • Source: devtool/lynx_devtool/agent/domain_agent/inspector_global_props_agent.cc
    Parameters

    No parameters.

    Returns
    NameTypeDescription
    globalPropsobjectComplete current GlobalProps value read from TemplateAssembler. An empty or not-yet-initialized value is returned as an empty object.
    timestampnumberBackend-generated timestamp of the most recent applied GlobalProps change, monotonically increasing within the target. The frontend uses it to order GlobalProps.changed events against this response, e.g. while refetching after a replace marker. Zero when no change has been observed.
    Notes
    • Dispatches through LynxDevToolMediator to InspectorTasmExecutor on the TASM task runner.
    • The response is serialized before it leaves the TASM task runner.
    • Returns a CDP error with code -32000 when the TASM target is unavailable.
    Examples

    Get current GlobalProps

    Request:

    {
      "id": 1,
      "method": "GlobalProps.get"
    }

    Response:

    {
      "id": 1,
      "result": {
        "globalProps": {
          "theme": "dark"
        },
        "timestamp": 1786956000123
      }
    }

    GlobalProps.replace

    Atomically replaces the complete authoritative GlobalProps object for the current Lynx target.

    • Origin: lynx-extension
    • Source: devtool/lynx_devtool/agent/domain_agent/inspector_global_props_agent.cc
    Parameters
    NameTypeRequiredDescription
    globalPropsobjectYesComplete replacement GlobalProps object. Keys omitted from this object are removed.
    Returns

    No return fields.

    Events
    • GlobalProps.changed: Emits a single replace change item. The frontend must call GlobalProps.get to rebuild its full state. The replace item never carries field values.
    Notes
    • Dispatches through LynxDevToolMediator to InspectorTasmExecutor on the TASM task runner.
    • The value must be a JSON object; arrays, scalar values, and null are rejected.
    • The update uses TemplateAssembler::UpdateGlobalProps so the TASM cache, MTS and BTS projections, and rendering follow the normal GlobalProps pipeline.
    • Returns a CDP error with code -32000 when the TASM target is unavailable.
    Examples

    Replace GlobalProps

    Request:

    {
      "id": 1,
      "method": "GlobalProps.replace",
      "params": {
        "globalProps": {
          "theme": "dark"
        }
      }
    }

    Response:

    {
      "id": 1,
      "result": {}
    }
    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.