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/react/Function.useSyncExternalStore.md.
  • English
  • @lynx-js/react / useSyncExternalStore

    Function: useSyncExternalStore()

    function useSyncExternalStore<Snapshot>(
       subscribe: (onStoreChange: () => void) => () => void, 
       getSnapshot: () => Snapshot, 
       getServerSnapshot?: () => Snapshot): Snapshot

    Type Parameters

    Type Parameter
    Snapshot

    Parameters

    ParameterTypeDescription
    subscribe(onStoreChange: () => void) => () => void
    getSnapshot() => Snapshot
    getServerSnapshot?() => Snapshot-

    Returns

    Snapshot

    See

    https://github.com/reactwg/react-18/discussions/86

    Defined in

    .pnpm/@types+react@18.3.28/node_modules/@types/react/ts5.0/index.d.ts:2176

    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.