Nexus (entry point)

// access
Nexus.init({ apiKey })

NexusCopy Anchor Link

The Nexus umbrella SDK — one entry point for every service, correlated to a single journey session. Isomorphic: works in every browser framework and in Node/Express.

import { Nexus } from '@inverge/nexus';
const nexus = Nexus.init({ apiKey: 'nxs_...' });
nexus.events.track('order_placed', { total: 42 });

init()Copy Anchor Link

static init(config: NexusConfig, opts?: { force?: boolean }): Nexus

Initialise the SDK. Idempotent: if an instance already exists it is returned as-is — a repeated call (an SSR module re-eval, an HMR reload, a second import) will NOT tear down and reconnect the live realtime socket. Pass { force: true } to deliberately dispose the current instance and start a fresh one (e.g. to switch API keys).

Parameters

Returns Nexus

configCopy Anchor Link

readonly config: ResolvedConfig

sessionsCopy Anchor Link

readonly sessions: NexusSessions

eventsCopy Anchor Link

readonly events: NexusEvents

logsCopy Anchor Link

readonly logs: NexusLogs

errorsCopy Anchor Link

readonly errors: NexusErrors

flagsCopy Anchor Link

readonly flags: NexusFlags

linksCopy Anchor Link

readonly links: NexusLinks

realtimeCopy Anchor Link

readonly realtime: NexusRealtime

remoteConfigCopy Anchor Link

readonly remoteConfig: NexusRemoteConfig

surveysCopy Anchor Link

readonly surveys: NexusSurveys

replayCopy Anchor Link

readonly replay: NexusReplay

pushCopy Anchor Link

readonly push: NexusPush

inAppCopy Anchor Link

readonly inApp: NexusInApp

liveActivitiesCopy Anchor Link

readonly liveActivities: NexusLiveActivities

instanceCopy Anchor Link

static readonly instance: Nexus

The app-wide instance. Throws if {@link init} hasn't run.

isInitializedCopy Anchor Link

static readonly isInitialized: boolean

distinctIdCopy Anchor Link

readonly distinctId: string | null

sessionKeyCopy Anchor Link

readonly sessionKey: string

enabled()Copy Anchor Link

enabled(service: NexusService): boolean

Whether a product is switched on — config services / NEXUS_<SERVICE>_ENABLED.

Parameters

Returns boolean

identify()Copy Anchor Link

identify(distinctId: string, options?: IdentifyOptions): Promise<void>

Identify the current end-user (shorthand for sessions.identify).

Parameters

reset()Copy Anchor Link

reset(): void

Forget the current user and start a fresh session (e.g. on logout).

flush()Copy Anchor Link

async flush(): Promise<void>

Flush all batched telemetry now.

dispose()Copy Anchor Link

dispose(): void

NexusConfigCopy Anchor Link

Configuration for {@link Nexus.init }.

apiKeyCopy Anchor Link

apiKey: string

Tenant API key (nxs_...). Sent as x-api-key, and in the socket handshake.

baseUrlCopy Anchor Link

baseUrl?: string

API origin. Partner endpoints live under /partner. Default https://services.inverge.net.

realtimeUrlCopy Anchor Link

realtimeUrl?: string

Realtime (Socket.IO) origin. Defaults to {@link baseUrl}.

autoTrackSessionsCopy Anchor Link

autoTrackSessions?: boolean

Start/refresh a journey session automatically. Default true.

autoCaptureErrorsCopy Anchor Link

autoCaptureErrors?: boolean

Capture uncaught errors automatically (browser window/unhandledrejection, Node process). Default true.

flushOnHideCopy Anchor Link

flushOnHide?: boolean

Flush queued telemetry on page hide / process exit. Default true.

flushIntervalMsCopy Anchor Link

flushIntervalMs?: number

Batch flush cadence (ms) for events/logs. Default 10000.

maxBatchCopy Anchor Link

maxBatch?: number

Max items per flush. Default 50.

logLevelCopy Anchor Link

logLevel?: 'silent' | 'error' | 'warn' | 'info' | 'debug'

Diagnostic verbosity. Default warn.

appVersionCopy Anchor Link

appVersion?: string

App/service version reported with telemetry.

defaultPropertiesCopy Anchor Link

defaultProperties?: Record<string, unknown>

Properties merged into every event/person context.

remoteConfigEnabledCopy Anchor Link

remoteConfigEnabled?: boolean

Fetch Remote Config at init (and on foreground). Default false.

remoteConfigRealtimeCopy Anchor Link

remoteConfigRealtime?: boolean

Re-fetch Remote Config live on publish (needs a realtime connection). Default false.

remoteConfigDefaultsCopy Anchor Link

remoteConfigDefaults?: Record<string, unknown>

In-app default Remote Config values.

replayEnabledCopy Anchor Link

replayEnabled?: boolean

Record browser session replay (rrweb). Requires the rrweb peer dependency. Browser-only; no-op on the server. Default false.

replayMaskAllInputsCopy Anchor Link

replayMaskAllInputs?: boolean

Redact every input value from replay. Default true.

replayBlockClassCopy Anchor Link

replayBlockClass?: string

CSS class on elements to fully block (never captured) in replay. Default nexus-block.

replayMaskTextClassCopy Anchor Link

replayMaskTextClass?: string

CSS class on elements whose text is masked in replay. Default nexus-mask.

replayFlushIntervalMsCopy Anchor Link

replayFlushIntervalMs?: number

How often (ms) buffered replay events are shipped. Default 5000.

fetchCopy Anchor Link

fetch?: typeof globalThis.fetch

Custom fetch implementation (defaults to global fetch).

servicesCopy Anchor Link

services?: Partial<Record<NexusService, boolean>>

Switch products off without removing their code, e.g. { liveActivities: false }. On Node the NEXUS_<SERVICE>_ENABLED environment variables apply too — off wins. A switched-off service makes no request and never throws.

enabledCopy Anchor Link

enabled?: boolean

false switches every service off (also NEXUS_ENABLED=false). Default true.