Skip to main content
Version: Unreleased

isWorkerRuntime

Available from 0.8.0

Checks if the current runtime is 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.

function checkUI() {
'worklet';
console.log(isWorkerRuntime()); // false (UI Runtime)
}
function checkWorker() {
'worklet';
console.log(isWorkerRuntime()); // true (Worker Runtime)
}
console.log(isWorkerRuntime()); // false (RN Runtime)
scheduleOnUI(checkUI);
const workerRuntime = createWorkletRuntime({ name: 'background' });
scheduleOnRuntime(workerRuntime, checkWorker);

Type definitions

function isWorkerRuntime(): boolean;

Returns​

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

Remarks​

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

We are Software Mansion.