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/genui/openui/data-tools/interfaces/QueryDataStore.md.
Lynx
  • English
  • Interface: QueryDataStore

    Local Query and Mutation operations over host-owned persistence.

    Methods

    getInitialQueryResults()

    getInitialQueryResults(prefetched?: Readonly<Record<string, unknown>>): InitialQueryResults

    Overlay saved results onto host prefetches for the renderer's initialQueryResults input. Only names present in defaults or prefetches are restored; defaults themselves are not copied.

    Parameters

    ParameterTypeDescription
    prefetched?Readonly<Record<string, unknown>>Host prefetches; defaults to an empty object.

    Returns

    InitialQueryResults


    getSnapshot()

    getSnapshot(): InitialQueryResults

    Read a detached snapshot of defaults overlaid with saved results without writing to storage.

    Returns

    InitialQueryResults


    mutate()

    mutate(key: string, value: unknown): void

    Replace one declared Query result with a detached JSON value and persist once; invalid values and storage failures throw.

    Parameters

    ParameterType
    keystring
    valueunknown

    Returns

    void


    query()

    query(key: string): unknown

    Read one declared Query result from the current persisted snapshot, preserving falsy values.

    Parameters

    ParameterType
    keystring

    Returns

    unknown

    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.