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

    Class: MainThreadRef<T>

    A MainThreadRef is a ref that can only be accessed on the main thread. It is used to preserve states between main thread function calls. The data saved in current property of the MainThreadRef can be read and written in multiple main thread functions.

    Extends

    • WorkletRef<T>

    Type Parameters

    Type Parameter
    T

    Constructors

    new MainThreadRef()

    new MainThreadRef<T>(initValue: T): MainThreadRef<T>

    Parameters

    ParameterType
    initValueT

    Returns

    MainThreadRef<T>

    Overrides

    WorkletRef<T>.constructor

    Defined in

    @lynx-js/react/runtime/lib/snapshot/worklet/ref/workletRef.d.ts:15

    Accessors

    current

    Get Signature

    get current(): T
    Returns

    T

    Set Signature

    set current(_: T): void
    Parameters
    ParameterType
    _T
    Returns

    void

    Inherited from

    WorkletRef.current

    Defined in

    @lynx-js/react/runtime/lib/snapshot/worklet/ref/workletRef.d.ts:4

    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.