Installation

npm

npm install @stxapp/stx-typescript

pnpm

pnpm add @stxapp/stx-typescript

yarn

yarn add @stxapp/stx-typescript

bun

bun add @stxapp/stx-typescript

Requires Node 18 or newer (or Bun). API-key signing uses Node’s crypto module, so run the client on a server, not in a browser.

Importing

import { STX } from "@stxapp/stx-typescript";

CommonJS works too:

const { STX } = require("@stxapp/stx-typescript");

Check the install

node -e 'import("@stxapp/stx-typescript").then((m) => console.log(m.VERSION))'

Pin an exact version in production. Before 1.0.0, a minor release can change the API.