canirequire › CommonJS › @octokit/types
Is @octokit/types ESM-only? Can you require() it?
Shared TypeScript definitions for Octokit projects
Last verified Sep 9, 2026 against @octokit/types@18.0.0. JSON
CommonJS CommonJS — require() works on every Node.js version
@octokit/types ships CommonJS only. require("@octokit/types") works everywhere. import "@octokit/types" 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.
Does @octokit/types@18.0.0 actually load? Runtime test results
Installed and executed on Sep 9, 2026 with require("@octokit/types") from a CommonJS file and import "@octokit/types" from an ES module.
| Runtime | require("@octokit/types") | import "@octokit/types" |
|---|---|---|
| Node.js 18 | ✗ failsMODULE_NOT_FOUND | ✗ failsERR_MODULE_NOT_FOUND |
| Node.js 20 | ✗ failsMODULE_NOT_FOUND | ✗ failsERR_MODULE_NOT_FOUND |
| Node.js 22 | ✗ failsMODULE_NOT_FOUND | ✗ failsERR_MODULE_NOT_FOUND |
| Node.js 24 | ✗ failsMODULE_NOT_FOUND | ✗ failsERR_MODULE_NOT_FOUND |
| Node.js 26 | ✗ failsMODULE_NOT_FOUND | ✗ failsERR_MODULE_NOT_FOUND |
| Bun 1.4 | ✗ failserror: Cannot find module '@octokit/types' from '/Users/boat/Projects/top-seo/data/probe-work/@octokit__types/req.cjs' | ✗ failserror: Cannot find module '@octokit/types' from '/Users/boat/Projects/top-seo/data/probe-work/@octokit__types/imp.mjs' |
A failing require() on a CommonJS package usually means the package needs a browser/DOM global, a peer dependency, or a native binary that is not available in a bare Node.js process.
How to import @octokit/types
ES modules (import)
import types from "@octokit/types";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 types = require("@octokit/types");Module format by version
Derived from the type, main and exports fields of every stable release on npm (219 versions; the newest 60 shown).
| Versions | Format | First published |
|---|---|---|
| 13.6.1 – 18.0.0 | CommonJS | Oct 3, 2024 |
| 13.5.1 – 13.6.0 | ESM-only | Sep 24, 2024 |
| 7.3.0 – 13.5.0 | CommonJS | Sep 7, 2022 |
Frequently asked
Is @octokit/types ESM-only?
@octokit/types@18.0.0 is a CommonJS package. @octokit/types ships CommonJS only. require("@octokit/types") works everywhere. import "@octokit/types" 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 @octokit/types with ES module syntax?
Yes. import types from "@octokit/types" 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 @octokit/types work in Bun?
Importing @octokit/types failed in Bun 1.4 on Sep 9, 2026: error: Cannot find module '@octokit/types' from '/Users/boat/Projects/top-seo/data/probe-work/@octokit__types/imp.mjs'
Does @octokit/types ship TypeScript types?
Yes. @octokit/types bundles its own type declarations; no @types package is needed.
Links
Other commonjs packages
- debug 4.4.3CommonJS
- semver 7.8.5CommonJS
- ms 2.1.3CommonJS
- picomatch 4.0.7CommonJS
- ajv 8.20.0CommonJS
- source-map 0.8.0CommonJS
- react-is 19.2.8CommonJS
- readable-stream 4.7.0CommonJS
Similar popularity
- buffer-from 1.1.2CommonJS
- get-nonce 1.0.1CommonJS
- set-function-name 2.0.2CommonJS
- cssstyle 6.2.0CommonJS
- fast-xml-parser 5.11.1Dual
- normalize-package-data 9.0.0CommonJS
- leven 4.1.0ESM-only
- unist-util-is 6.0.1ESM-only