Version: Unreleased

isUIRuntime

Available from 0.8.0

Checks if the current runtime is the UI Runtime.

Reference

Code

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

function checkUI() {

'worklet';

console.log(isUIRuntime()); // true (UI Runtime)

}

function checkWorker() {

'worklet';

console.log(isUIRuntime()); // false (Worker Runtime)

}

console.log(isUIRuntime()); // false (RN Runtime)

scheduleOnUI(checkUI);

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

scheduleOnRuntime(workerRuntime, checkWorker);

Type definitions

function isUIRuntime(): boolean;

true if the current runtime is the UI Runtime, false otherwise.

The function checks the value of globalThis.__RUNTIME_KIND to determine the kind of the current runtime. See getRuntimeKind for more details.