Getting Started

Welcome to Apexify.js — a Node/server library for programmatic PNG/image composition, text, charts, GIFs, FFmpeg-backed video, procedural audio, scenes, templates, and batch/output workflows.

Release status: these docs describe the staged Apexify.js 6.0.0 package artifact produced from the current repository. npm latest is still 5.4.5, so npm install apexify.js currently installs 5.4.5. Do not use the 6.0 API reference against npm latest until 6.0.0 is explicitly published.

#Requirements for staged 6.0.0

• Node.js 22.x, 24.x, or 26.x
• npm 10+
• FFmpeg + ffprobe only for video/FFmpeg features
• TypeScript is optional; package declarations ship for ESM and CommonJS consumers

Apexify.js 6 is a Node/server package. Browser-native, React/Next, Render-IR/ARS, native browser animation, AI-assistant, and distributed-renderer packages are not current shipped 6.0 APIs.

#Published npm install

1$ npm install apexify.js

That currently installs the published 5.4.5 release. The 6.0 documentation site itself is validated against an exact staged package commit rather than pretending npm already contains 6.0.0.

#ESM and CommonJS

1// ESM2import { ApexPainter } from "apexify.js";3 4// CommonJS5const { ApexPainter } = require("apexify.js");

apexify.js/types is a type-only subpath. Do not import internal source or dist/* paths.

#Smallest staged-6 example

1import { writeFile } from "node:fs/promises";2import { ApexPainter } from "apexify.js";3 4const painter = new ApexPainter({ type: "buffer" });5const canvas = await painter.createCanvas({6  width: 640,7  height: 360,8  colorBg: "#0f172a",9});10 11const png = await painter.createText(12  {13    text: "Apexify.js",14    x: 320,15    y: 180,16    font: { size: 48, family: "Arial" },17    fill: { color: "#ffffff" },18    placement: { textAlign: "center", textBaseline: "middle" },19  },20  canvas,21);22 23await writeFile("out.png", png);

createCanvas() returns CanvasResults (buffer plus canvas metadata). Normal raster rendering methods return PNG Buffers; constructor output type is applied explicitly through toOutput().

#Read in this order

Use Security deployment before exposing Apexify to untrusted URLs/uploads, and Performance & memory before increasing resource/concurrency limits.