You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Consider allowing packages to define multiple canonical names for their modules #42764
This is based on a change in the NodeJS definitions: DefinitelyTyped/DefinitelyTyped#51107. For Node's ESM support, you can import NodeJS core packages (i.e., fs, path, etc.) using a fully-qualified URN with the node: prefix. The approach taken in DefinitelyTyped/DefinitelyTyped#51107 is to re-export a module like fs using another ambient module:
However, this belies the actual behavior of the import. "node:fs" is not a different module that happens to re-export "fs", it is actually the same module, and ideally would be handled in a way similar to how we currently handle symbolic links. With the above definitions, any module augmentations must always be made against the non-prefixed form of the module. Augmentations of the prefixed-form would be missing when importing the non-prefixed form.
We already have some mechanisms for handling this in your own project (i.e., via "paths", etc.), but not when importing from an external package (such as is the case with "fs", "path", etc.).
Should we consider adding a mechanism, be it either via syntax or via configuration (stored in package.json)?
Syntax
We can bikeshed on syntax, but I've presented a few options below:
// 1) variation of `export as namespace ...`declare module "fs"{exportas module "node:fs";// essentially a symbolic link from `"node:fs"` to `"fs"`}// 2) declare a module with multiple namesdeclare module "fs","node:fs"{}
Configuration
If we consider approaching this problem from a configuration standpoint there are a number of directions we could take. I can update this section as we discuss this issue.
Also should consider which module name takes precidence when automatically importing, probably want to use declaration order if we go with the declare module "fs", "node:fs" syntax, or have some sort of override.
Reacted by ExE Boss, Jarrod Davis, Sachin Shekhar and Merlin Fisher
A separate option I've considered is adding a new node-esm package to DefinitelyTyped that merely re-exports the node core packages with node:* names, though such a package would likely be short-lived.
Activity
SimonSchick commentedon Apr 1, 2021
Also should consider which module name takes precidence when automatically importing, probably want to use declaration order if we go with the
declare module "fs", "node:fs"syntax, or have some sort of override.rbuckton commentedon May 7, 2021
A separate option I've considered is adding a new
node-esmpackage to DefinitelyTyped that merely re-exports the node core packages withnode:*names, though such a package would likely be short-lived.karlhorky commentedon May 30, 2021
As a side note regarding the
node:protocol, looks like thenode:scheme / prefix was backported to Node.js 14.13.1 / 12.20.0 🎉https://nodejs.org/api/esm.html -> link "node: Imports" (links with anchors don't scroll properly right now)
karlhorky commentedon Jul 3, 2021
@types/node@16.0.0has been published now - thenode:schema / prefix now works again:rmartins0 commentedon Jun 19, 2025
Is this related and does anyone know about this?