Home > @lynx-js/react > runOnMainThread

#runOnMainThread() function

runOnMainThread allows triggering main thread functions on the main thread asynchronously.

Signature:

export declare function runOnMainThread<R, Fn extends (...args: any[]) => R>(fn: Fn): (...args: Parameters<Fn>) => Promise<R>;

#Parameters

Returns:

(...args: Parameters<Fn>) => Promise<R>

A function. Calling which with the arguments to be passed to the main thread function to trigger it on the main thread. This function returns a promise that resolves to the return value of the main thread function.

#Example

import { runOnMainThread } from '@lynx-js/react';

async function someFunction() {
  const fn = runOnMainThread(() => {
    'main thread';
    return 'hello';
  });
  const result = await fn();
}