Home > @lynx-js/react > runOnBackground

#runOnBackground() function

runOnBackground allows triggering js functions on the background thread asynchronously.

Signature:

export declare function runOnBackground<R, Fn extends (...args: any[]) => R>(f: 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 js function to trigger it on the background thread. This function returns a promise that resolves to the return value of the js function.

#Example

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

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