nexus
Core API

Packages And Imports

Find optional packages and Core subpath entrypoints.

For initial setup, use Installation. This page lists additional capabilities and their imports.

Packages

PackagePurposeGuide
@nexus-js/coreConnections, services, callbacks, and resourcesQuick start
@nexus-js/chromeChrome extension communicationChrome
@nexus-js/iframeParent/iframe communicationiframe
@nexus-js/node-ipcLocal daemon/client communicationNode IPC
@nexus-js/reactReact bindingsReact
@nexus-js/testingApplication-level test doublesTesting

Install testing utilities as a development dependency. They mock the public application seam, not transports or real sessions.

Core Subpath Imports

These entrypoints are included in @nexus-js/core; they are not separate packages to install.

ImportPurpose
@nexus-js/core/stateSynchronized state
@nexus-js/core/transportTransport contracts for adapter authors
@nexus-js/core/transport/virtual-portPort multiplexing over message buses

For example:

import { connectNexusStore } from "@nexus-js/core/state";

Applications using an existing adapter normally do not need the low-level transport entrypoints.

Edit this page on GitHub