Skip to content

Update docs for native ESM in TypeScript #15461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update docs for native ESM in TypeScript #15461

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f8d6c5
Update docs for native ESM in TypeScript
julienp Jul 2, 2025
b02ad56
Apply suggestion from @julienp
julienp Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions content/docs/iac/languages-sdks/javascript/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,25 +223,28 @@ If you wish to instead use [ESM](https://nodejs.org/api/esm.html) natively, you
}
```

Your `tsconfig.json` file should also be updated to ensure that TypeScript outputs ESM, by setting the [`module`](https://www.typescriptlang.org/tsconfig/#module) field to `ESNext`, or one of `ES2015/ES6/ES2020/ES2022`.
Your `tsconfig.json` file should also be updated to ensure that TypeScript outputs ESM, by setting the [`module`](https://www.typescriptlang.org/tsconfig/#module) and [`moduleResolution`](https://www.typescriptlang.org/tsconfig/#moduleResolution) fields to `nodenext`.

```json
{
"compilerOptions": {
...
"module": "ESNext",
"module": "nodenext",
"moduleResolution": "nodenext",
...
}
}
```

Install a recent version of `ts-node` to use its [ESM loader](https://typestrong.org/ts-node/docs/imports#native-ecmascript-modules).
Install a recent version of `typescript` and `ts-node`.

```bash
npm isntall typescript@^5
npm install ts-node@^10
```

Lastly, you need to instruct Pulumi to use the `ts-node/esm` loader by setting the `nodeargs` option in the [`runtime`](https://www.pulumi.com/docs/iac/concepts/projects/project-file/#runtime-options) options in `Pulumi.yaml`.
{{< notes >}}
When using a version of `@pulumi/pulumi` older than 3.183.0, you need to instruct Pulumi to use the `ts-node/esm` loader by setting the `nodeargs` option in the [`runtime`](https://www.pulumi.com/docs/iac/concepts/projects/project-file/#runtime-options) options in `Pulumi.yaml`. More recent versions automatically configure this.

```yaml
name: project-using-native-esm
Expand All @@ -251,6 +254,8 @@ runtime:
nodeargs: "--loader ts-node/esm --no-warnings"
```

{{< /notes >}}

## Using ESM only modules with CommonJS Pulumi templates

Older versions of Node.js do not support loading ESM modules using the `require` function (`require` is part of CommonJS, the default runtime targetted by TypeScript in the Pulumi templates). You may encounter an error like the following:
Expand Down
Loading