Utilities

import { NexusLog, isBrowser } from '@inverge/nexus'

NexusLogCopy Anchor Link

Minimal leveled logger; never throws.

configure()Copy Anchor Link

static configure(level: Level): void

Parameters

debug()Copy Anchor Link

static debug(msg: string): void

Parameters

info()Copy Anchor Link

static info(msg: string): void

Parameters

warn()Copy Anchor Link

static warn(msg: string): void

Parameters

error()Copy Anchor Link

static error(msg: string, err?: unknown): void

Parameters

mask()Copy Anchor Link

static mask(key: string): string

Parameters

Returns string

NexusServiceCopy Anchor Link

export type NexusService = | 'realtime' | 'events' | 'errors' | 'logs' | 'sessions' | 'flags' | 'remoteConfig' | 'links' | 'surveys' | 'push' | 'inApp' | 'liveActivities' | 'replay' | 'telescope';

Per-service on/off switches — turn a Nexus product off without removing the code that uses it. A switched-off service makes no network call and never throws: writes are skipped and reads return their neutral value (flags → defaults, Remote Config → defaults, lists → empty).

Node reads the environment (all default to on):

NEXUS_ENABLED=false # everything off NEXUS_PUSH_ENABLED=false # only push off NEXUS_LIVE_ACTIVITIES_ENABLED=false # only Live Activities off

In the browser (no environment) pass services: { push: false } / enabled: false to Nexus.init. Off wins: a service is on only if neither the config nor the environment turns it off.

FunctionsCopy Anchor Link

isBrowserCopy Anchor Link

const isBrowser: boolean

Runtime environment detection (isomorphic — browser vs Node).

isNodeCopy Anchor Link

const isNode: boolean

platformName()Copy Anchor Link

platformName(): string

Best-effort platform label for targeting/telemetry.

Returns string

SERVICE_ENVCopy Anchor Link

const SERVICE_ENV: Readonly<Record<NexusService, string>>

Service → the environment variable that switches it.