canirequire

canirequire › CommonJS › vinyl

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

Virtual file format.

Last verified Sep 9, 2026 against vinyl@3.0.1. JSON

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

vinyl ships CommonJS only. require("vinyl") works everywhere. import "vinyl" 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
3.0.1 (May 31, 2025)
Module format
CommonJS
Last CommonJS version
3.0.1
TypeScript types
@types/vinyl
Node engines
>=10.13.0
Weekly downloads
7.6M
License
MIT

Does vinyl@3.0.1 actually load? Runtime test results

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

Runtimerequire("vinyl")import "vinyl"
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 vinyl

ES modules (import)

import vinyl from "vinyl";

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 vinyl = require("vinyl");

Module format by version

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

VersionsFormatFirst published
0.1.0 – 3.0.1CommonJSDec 21, 2013

Frequently asked

Is vinyl ESM-only?

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

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

Yes. import "vinyl" loaded successfully in Bun 1.4 on Sep 9, 2026.

Does vinyl ship TypeScript types?

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

Links

Other commonjs packages

Similar popularity