Skip to main content

​
Install

The package is served from the GitLab npm Package Registry and is public - no auth token is required to install. Point the @westyx-nexus scope at it in your .npmrc:
One package, one endpoint. The provider carries the Nexus browser client itself, so nothing else has to be installed or configured to make it resolve.

​
Requirements

Both ESM and CommonJS builds ship, each with its own type declarations.

​
Use a public API key

The apiKey must be a wxp_... public (browser) key. Secret (wxs_...) backend keys are not accepted by the browser-facing API endpoints and must never be embedded in browser code.
A public key is safe to ship in a bundle: it cannot read secrets, and the backend’s Double-Gate check ties it to one service host. Any other key is rejected when the provider initialises, with a NexusConfigError that names the option and carries only the key’s prefix - never its material. Create one in the Nexus admin console under the service’s API keys, choosing the public key type. The key is sent in the X-Nexus-API-Key request header on every call, so it never appears in a URL, in browser history, or in a referrer.

​
TypeScript

Type declarations are bundled with the package. No @types/ package is needed.