scheduleOnRuntime

scheduleOnRuntime lets you schedule a worklet function to be executed on a Worker Runtime.

Reference

Code

Code

Colours connect each executing thread to its current code line. Recently executed lines fade over the next three ticks.

1function greet(greeting) {

2 'worklet';

3 console.log(`${greeting} from the background Worklet Runtime`);

4}

5

6const workletRuntime = createWorkletRuntime({ name: 'background' });

7scheduleOnRuntime(workletRuntime, greet, 'Hello');

8console.log('The RN Runtime continues');

Type definitions

function scheduleOnRuntime<Args extends unknown[], ReturnValue>(
  workletRuntime: WorkletRuntime,
  worklet: (...args: Args) => ReturnValue,
  ...args: Args
): void;

Arguments

workletRuntime

The worklet runtime to schedule the worklet function on.

worklet

A reference to a function you want to execute on the Worker Runtime.

args

Arguments to the function you want to execute on the Worker Runtime.

Remarks

• The worklet function is scheduled on the Worker Runtime's Async Queue

Call table

Mode	RN Runtime	UI Runtime	Worker Runtime
Bundle Mode	✅	✅	✅
Legacy Eval Mode	✅	✅	✅

What does it mean?

Platform compatibility

Native	Web
✅	❌