Skip to content

Environment Info (Env)

Synchronously retrieves runtime environment information (via the env channel).

js
import { getEnv } from 'yeow-api';

const env = getEnv();
console.log(env.arch, env.minecraftVersion, env.yeow.version);

Returns EnvInfo:

FieldTypeDescription
cpusnumberNumber of logical CPU cores
memorynumberTotal JVM memory (in bytes)
archstringSystem architecture (e.g. windows-x64 / linux-x64 / linux-arm64)
minecraftVersionstringMinecraft version (e.g. 1.21.4)
yeowRuntime information (e.g. { platform: 'paper', version: '0.5.0' })
nownumberEpoch microseconds timestamp
pluginDirstringPlugin data directory path (e.g. plugins/my-plugin on Paper/Folia; the main plugin directory in a Worker)

now is a microsecond-level timestamp — communication overhead is at the microsecond level, so nanoseconds are meaningless.