Docs

From zero to your first print, then the full reference once you need it.

Quick Start

1. 1. Install the SDK

   npm install @portixone/sdk

2. 2. Try it with no runtime and no printer

   import { Portix } from "@portixone/sdk";
   
   const portix = new Portix({ mode: "mock" });
   await portix.connect();
   
   await portix.print({ content: "Hello PortixOne!" });
   // Renders a text preview in the console — no hardware needed.

   This is the fastest way to confirm the API shape before installing the Runtime.

3. 3. Install the Runtime for a real print

   Download PortixOneRuntimeSetup.exe from the latest release, run it (no Node.js or other prerequisites — it's bundled), and it installs as a Windows Service that starts automatically.

4. 4. Swap `mode: "mock"` for your app identity and print for real

   import { Portix } from "@portixone/sdk";
   
   const portix = new Portix({ appId: "my-app", tenant: "default" });
   await portix.connect();
   
   await portix.print({ content: "Hello PortixOne!" });

   `mode: "mock"` becomes your integration's `appId`/`tenant` — the first `connect()` pairs automatically (instant from a browser on `localhost`). See the SDK reference for every option `print()` and the rest of the class accept.

Reference