canirequire › CommonJS › yaml
Is yaml ESM-only? Can you require() it?
JavaScript parser and stringifier for YAML
Last verified Sep 9, 2026 against yaml@2.9.0. JSON
CommonJS CommonJS — require() works on every Node.js version
yaml ships CommonJS only. require("yaml") works everywhere. import "yaml" 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 yaml@2.9.0 actually load? Runtime test results
Installed and executed on Sep 9, 2026 with require("yaml") from a CommonJS file and import "yaml" from an ES module.
| Runtime | require("yaml") | import "yaml" |
|---|---|---|
| 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 yaml
ES modules (import)
import yaml from "yaml";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 yaml = require("yaml");Module format by version
Derived from the type, main and exports fields of every stable release on npm (68 versions; the newest 60 shown).
| Versions | Format | First published |
|---|---|---|
| 2.0.0 – 2.9.0 | CommonJS | Apr 6, 2022 |
| 1.8.0 – 1.10.3 | Dual (CommonJS + ESM) | Mar 7, 2020 |
| 1.0.0 – 1.7.2 | CommonJS | Sep 19, 2018 |
Frequently asked
Is yaml ESM-only?
yaml@2.9.0 is a CommonJS package. yaml ships CommonJS only. require("yaml") works everywhere. import "yaml" 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 yaml with ES module syntax?
Yes. import yaml from "yaml" 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 yaml work in Bun?
Yes. import "yaml" loaded successfully in Bun 1.4 on Sep 9, 2026.
Does yaml ship TypeScript types?
Yes. yaml 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
- fast-deep-equal 3.1.3CommonJS
- yargs-parser 22.0.0ESM-only
- inherits 2.0.4CommonJS
- caniuse-lite 1.0.30001810CommonJS
- detect-libc 2.1.2CommonJS
- graceful-fs 4.2.11CommonJS
- isarray 2.0.5CommonJS
- magic-string 1.2.3ESM-only