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

> vinyl@3.0.1 is a CommonJS package. CommonJS — require() works on every Node.js version we test.

Virtual file format.

Last verified Sep 9, 2026 against vinyl@3.0.1.

vinyl ships CommonJS only. require("vinyl") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js >=10.13.0. 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.

## What to do

1. require("vinyl") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js >=10.13.0.
2. From ES modules use the default import: import vinyl from "vinyl"; then destructure. Named imports only work when Node.js can statically detect the exports.
3. TypeScript: npm install -D @types/vinyl

## Facts

- 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

## Runtime test results for vinyl@3.0.1

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

| Runtime | require("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.0 | works | works |

## How to import vinyl

ES modules:

```js
import vinyl from "vinyl";
```

CommonJS:

```js
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).

| Versions | Format | First published |
|---|---|---|
| 0.1.0 – 3.0.1 | CommonJS | Dec 21, 2013 |

## Frequently asked

**Is vinyl ESM-only?**

vinyl@3.0.1 is a CommonJS package. vinyl ships CommonJS only. require("vinyl") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js >=10.13.0. 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.0 on Sep 9, 2026.

**Does vinyl ship TypeScript types?**

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

## Links

- [vinyl on npm](https://www.npmjs.com/package/vinyl)
- [Source repository](https://github.com/gulpjs/vinyl)
- [HTML version](https://canirequire.com/package/vinyl/)
- [JSON version](https://canirequire.com/package/vinyl.json)

---

For scripts and AI agents: any package is at https://canirequire.com/package/<name>/index.md (Markdown) or https://canirequire.com/package/<name>.json (JSON); the site index is https://canirequire.com/llms.txt. Fetch the URL directly; no search needed.