canirequire

canirequire › CommonJS › gh-pages

Is gh-pages ESM-only? Can you require() it?

Publish to a gh-pages branch on GitHub (or any other branch on any other remote)

Last verified Sep 9, 2026 against gh-pages@6.3.0. JSON

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

gh-pages ships CommonJS only. require("gh-pages") works everywhere. import "gh-pages" 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.

Latest
6.3.0 (Jan 2, 2025)
Module format
CommonJS
Last CommonJS version
6.3.0
TypeScript types
@types/gh-pages
Node engines
>=10
Weekly downloads
569K
License
MIT

Does gh-pages@6.3.0 actually load? Runtime test results

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

Runtimerequire("gh-pages")import "gh-pages"
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✓ works✓ works

How to import gh-pages

ES modules (import)

import ghPages from "gh-pages";

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 ghPages = require("gh-pages");

Module format by version

Derived from the type, main and exports fields of every stable release on npm (34 versions; the newest 34 shown).

VersionsFormatFirst published
0.1.0 – 6.3.0CommonJSMar 18, 2014

Frequently asked

Is gh-pages ESM-only?

gh-pages@6.3.0 is a CommonJS package. gh-pages ships CommonJS only. require("gh-pages") works everywhere. import "gh-pages" 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 gh-pages with ES module syntax?

Yes. import ghPages from "gh-pages" 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 gh-pages work in Bun?

Yes. import "gh-pages" loaded successfully in Bun 1.4 on Sep 9, 2026.

Does gh-pages ship TypeScript types?

Not bundled. Install the community types with "npm install -D @types/gh-pages".

Links

Other commonjs packages

Similar popularity