canirequire

canirequire › CommonJS › canvas

Is canvas ESM-only? Can you require() it?

Canvas graphics API backed by Cairo

Last verified Sep 9, 2026 against canvas@3.2.3. Markdown · JSON

CommonJS CommonJS — require() works on every Node.js version we test

canvas ships CommonJS only. require("canvas") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js ^18.12.0 || >= 20.9.0. import "canvas" also works because Node.js and Bun can import CommonJS from ES modules, but only the default export is guaranteed; named imports depend on Node's static analysis of the module.

What to do

  1. require("canvas") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js ^18.12.0 || >= 20.9.0.
  2. From ES modules use the default import: import canvas from "canvas"; then destructure. Named imports only work when Node.js can statically detect the exports.
  3. TypeScript: types are bundled; install nothing extra.
Latest
3.2.3 (Mar 31, 2026)
Module format
CommonJS
Last CommonJS version
3.2.3
TypeScript types
Bundled
Node engines
^18.12.0 || >= 20.9.0
Weekly downloads
5.4M
License
MIT

Does canvas@3.2.3 actually load? Runtime test results

Installed and executed on Sep 9, 2026 with require("canvas") from a CommonJS file and import "canvas" from an ES module.

Runtimerequire("canvas")import "canvas"
Node.js 18✓ works✓ works
Node.js 20✓ works✓ works
Node.js 22✓ works✓ works
Node.js 24✓ works✓ works
Node.js 26✓ works✓ works
Bun 1.4.0✓ works✓ works

How to import canvas

ES modules (import)

import canvas from "canvas";

Named imports from a CommonJS package only work when Node.js can statically detect them. If a named import fails, use the default import and destructure.

CommonJS (require)

const canvas = require("canvas");

Module format by version

Derived from the type, main and exports fields of every stable release on npm, corrected where a runtime test of that version contradicted them (134 versions; the newest 60 shown).

VersionsFormatFirst published
1.3.4 – 3.2.3CommonJSNov 21, 2015

Frequently asked

Is canvas ESM-only?

canvas@3.2.3 is a CommonJS package. canvas ships CommonJS only. require("canvas") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js ^18.12.0 || >= 20.9.0. import "canvas" also works because Node.js and Bun can import CommonJS from ES modules, but only the default export is guaranteed; named imports depend on Node's static analysis of the module.

Can I import canvas with ES module syntax?

Yes. import canvas from "canvas" works in Node.js and Bun because they support importing CommonJS modules. Named imports work only when Node.js can statically detect the exports.

Does canvas work in Bun?

Yes. import "canvas" loaded successfully in Bun 1.4.0 on Sep 9, 2026.

Does canvas ship TypeScript types?

Yes. canvas bundles its own type declarations; no @types package is needed.

Links

Other commonjs packages

Similar popularity