Lynx/Modules/Observability/Installation
@sigx/lynx-observability · Stable

Installation#

Add @sigx/lynx-observability to your project.

Install the package#

Terminal
pnpm add @sigx/lynx-observability

Native setup#

The package ships native code for Memory, so re-run prebuild after installing:

Terminal
sigx prebuild

sigx prebuild auto-discovers the package and registers its native module on both platforms. No permissions, Info.plist strings or manifest entries are needed.

Adding native sources changes the app's OTA runtime fingerprint. After installing: run sigx prebuild, cut a store release, and republish your update bundles once the new binary is live — see runtime-version compatibility.

Memory requires Lynx ≥ 4.0.1 — the engine the CLI's native templates pin. An older engine pin fails at native compile time with an unhelpful message rather than a clear one.

Verify#

TSX
import { Memory } from '@sigx/lynx-observability';

console.log(Memory.isAvailable()); // true once the native module is linked