Skip to content
Apexify.jsDocs
Apexify.js version v5.4.5

Start · tutorial

How buffers work

Current Apexify.js 6.0.0 documentation for How buffers work.

apexify.jsRuntime: nodeCURRENTSince 6.0.0

What createCanvas returns

SOURCEtypescript
typescript
Studio
const { buffer, canvas } = await painter.createCanvas({ ... });
FieldMeaning
bufferBuffer — PNG image bytes.
canvasCopy of the config you passed (CanvasConfig) — handy for debugging.

Chaining operations

Later methods take that buffer (or CanvasResults) and return a new buffer:

SOURCEtypescript
typescript
Studio
let { buffer } = await painter.createCanvas({  width: 600,  height: 400,  colorBg: '#111827',}); buffer = await painter.createText(  {    text: 'Hello',    x: 300,    y: 220,    font: { size: 42, family: 'Arial' },    color: '#f9fafb',    textAlign: 'center',    textBaseline: 'middle',  },  buffer); fs.writeFileSync('step2.png', buffer);

Why: each step composites on top of the previous image. If you pass an old buffer, you lose newer work.

CanvasResults shorthand

Some APIs accept CanvasResults (object with .buffer) or a raw Buffer:

SOURCEtypescript
typescript
Studio
const scene = await painter.createCanvas({ width: 400, height: 300, colorBg: '#fff' });await painter.createText({ text: 'A', x: 50, y: 50, font: { size: 24, family: 'Arial' } }, scene);await painter.createText({ text: 'B', x: 50, y: 100, font: { size: 24, family: 'Arial' } }, scene.buffer);

Both styles work — use whichever is clearer.

Next steps

Beginner guideGuide · node · CURRENT

Current Apexify.js 6.0.0 documentation for Beginner guide.

Getting StartedGuide · node · CURRENT

Install the staged Apexify.js 6.0.0 package, understand its Node/server requirements, and render a first image.

Feature tracks — where to go nextGuide · node · CURRENT

Current Apexify.js 6.0.0 documentation for Feature tracks — where to go next.

Install & setupGuide · node · CURRENT

Current Apexify.js 6.0.0 documentation for Install & setup.