Apexify.js documentation

This site documents the staged Apexify.js 6.0.0 Node/server package artifact and is tested against an exact repository commit. npm latest remains 5.4.5 until 6.0.0 is explicitly published.

The documentation hierarchy is intentionally split between learning material and contract/reference material:

• tutorials/recipes explain workflows;
• feature guides explain domain behavior and options;
• API Reference inventories the current public package surface;
• Advanced contains runtime policy, security, performance, migration, and composition/media depth;
• Internals/changelog pages are historical/developer context and must not override current runtime/export truth.

#Where to begin

1. Start here — scope, release status, runtime requirements, minimal example.
2. Install & setup — Node/npm/module/FFmpeg requirements.
3. Beginner guide — first real images and buffers.
4. Feature guides — canvas, images, text, charts, GIF, video, raster/output.
5. API reference — current exports, ApexPainter, facets, configuration, errors, public type domains.
6. Advanced — scenes/templates/assets/plugins/audio/video plus operational guides.

#Folder map

#Source of truth

For current behavior, use this precedence:

1. current merged package source/runtime implementation;
2. current package exports and generated declarations;
3. packed-package consumer fixtures/tests;
4. this API Reference and current guides;
5. historical internals/changelog material.

If a historical page contradicts a current API-reference page, the historical page is not the runtime contract.

The current public package exposes only declared package exports (apexify.js, type-only apexify.js/types, and apexify.js/package.json). Do not teach or depend on internal lib-next/* / dist/* paths.

#Operational docs

• Runtime validation & resource governance
• Security deployment
• Performance & memory
• Migration to Apexify.js 6

These are part of the public contract for production/server use, not optional contributor notes.