env

import {env} from 'mikro/env'

Read environment variables stored in NVSNon-Volatile Storage on the device. Provides explicit methods for required vs. optional access, replacing direct import.meta.env property access.

Storage is not encrypted

NVSNon-Volatile Storage values are plaintext; anyone with physical access can dump them. See Environment Variables for the full picture.

env.require(key)

env.require(key: string): string

Get a required environment variable. Panics with a clear error message if the variable is not set.

const ssid = env.require('WIFI_SSID')
// TypeError: Required environment variable "WIFI_SSID" is not set

Use this for variables your app cannot function without (for example WiFi credentials or APIApplication Programming Interface keys).

env.get(key)

env.get(key: string): string | undefined

Get an optional environment variable. Returns undefined if not set.

const debug = env.get('DEBUG')
if (debug) {
  console.log('Debug mode enabled')
}

env.has(key)

env.has(key: string): boolean

Check whether an environment variable is set.

if (env.has('LOG_LEVEL')) {
  // configure logging
}

Setting environment variables

See the Environment Variables guide for how to set variables via the CLICommand-Line Interface, .env files, and secrets.