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

Parameter Type
initValue T

Returns

MainThreadRef<T>

Overrides

WorkletRef<T>.constructor

Defined in

@lynx-js/react/runtime/lib/worklet/workletRef.d.ts:14

Accessors

current

Get Signature

get current(): T
Returns

T

Set Signature

set current(_: T): void
Parameters
Parameter Type
_ T
Returns

void

Inherited from

WorkletRef.current

Defined in

@lynx-js/react/runtime/lib/worklet/workletRef.d.ts:3

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.