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

> gcp-metadata@9.0.3 is a CommonJS package. CommonJS — require() works on every Node.js version we test.

Get the metadata from a Google Cloud Platform environment

Last verified Sep 9, 2026 against gcp-metadata@9.0.3.

gcp-metadata ships CommonJS only. require("gcp-metadata") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js >=22. import "gcp-metadata" 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("gcp-metadata") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js >=22.
2. From ES modules use the default import: import gcpMetadata from "gcp-metadata"; then destructure. Named imports only work when Node.js can statically detect the exports.
3. TypeScript: types are bundled; install nothing extra.

## Facts

- Latest: 9.0.3 (Aug 12, 2026)
- Module format: CommonJS
- Last CommonJS version: 9.0.3
- TypeScript types: bundled
- Node engines: >=22
- Weekly downloads: 78.5M
- License: Apache-2.0

## Runtime test results for gcp-metadata@9.0.3

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

| Runtime | require("gcp-metadata") | import "gcp-metadata" |
|---|---|---|
| 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 gcp-metadata

ES modules:

```js
import gcpMetadata from "gcp-metadata";
```

CommonJS:

```js
const gcpMetadata = require("gcp-metadata");
```

## Module format by version

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

| Versions | Format | First published |
|---|---|---|
| 0.1.0 – 9.0.3 | CommonJS | Dec 16, 2016 |

## Frequently asked

**Is gcp-metadata ESM-only?**

gcp-metadata@9.0.3 is a CommonJS package. gcp-metadata ships CommonJS only. require("gcp-metadata") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js >=22. import "gcp-metadata" 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 gcp-metadata with ES module syntax?**

Yes. import gcpMetadata from "gcp-metadata" 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 gcp-metadata work in Bun?**

Yes. import "gcp-metadata" loaded successfully in Bun 1.4.0 on Sep 9, 2026.

**Does gcp-metadata ship TypeScript types?**

Yes. gcp-metadata bundles its own type declarations; no @types package is needed.

## Links

- [gcp-metadata on npm](https://www.npmjs.com/package/gcp-metadata)
- [Source repository](https://github.com/googleapis/google-cloud-node)
- [HTML version](https://canirequire.com/package/gcp-metadata/)
- [JSON version](https://canirequire.com/package/gcp-metadata.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.