Version: Unreleased

isWorkletRuntime

Available from 0.8.0

Checks if the current runtime is a Worklet Runtime, either the UI Runtime or a Worker 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(isWorkletRuntime()); // true (UI Runtime)

}

function checkWorker() {

'worklet';

console.log(isWorkletRuntime()); // true (Worker Runtime)

}

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

scheduleOnUI(checkUI);

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

scheduleOnRuntime(workerRuntime, checkWorker);

Type definitions

function isWorkletRuntime(): boolean;

true if the current runtime is a Worklet 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.