Managers once published, their development teams are often required to use one While all Node.js projects are expected to be installable by all package cjs files are treated as CommonJS within a Interpret a particular file as an ES module by naming it with an. Within a 'type': 'commonjs' package, Node.js can be instructed to mjs files are treated as ES modules within Interpret a particular file as CommonJS by naming it with a. Within a 'type': 'module' package, Node.js can be instructed to cjs extensions can be used to mix types within the same cjs are always loaded as CommonJS regardless of the mjs are always loaded as ES modules regardless ofįiles ending with. node_modules/commonjs-package/package.json // lacks a 'type' field or contains 'type': 'commonjs'.įiles ending with. import './node_modules/commonjs-package/index.js' node_modules/commonjs-package/package.json // lacks a 'type' field or contains 'type': 'commonjs'.

startup contains no package.json file, // and therefore inherits the 'type' value from one level up. my-app.js, treated as an ES module because there is a package.json // file in the same folder with 'type': 'module'. The 'type' field applies not only to initial entry points ( node my-app.js)īut also to files referenced by import statements and import() expressions. jsįiles within that package as using ES module syntax. js files are treated as CommonJS.Ī package.json 'type' value of 'module' tells Node.js to interpret. Within a package, the package.json 'type' field defines how

Paths and are then loaded via the CommonJS module loader. Imported CommonJS modules have their URLs converted to absolute Which are available if they can be determined through static analysis. Such modulesĪre passed through the es-module-lexer to try to identify named exports, It can be used to load JavaScript CommonJS modules.It can load JSON modules, but an import assertion is required.When the specifier is a relative or absolute file URL. './startup/index.js') must be fully specified. It does not support folders as modules, directory indexes (e.g.It is not monkey patchable, can be customized using loader hooks.It is responsible for handling import statements and import() expressions.JavaScript text file that is not an ECMAScript module, it loads it as a Load ECMASCript modules from CommonJS modules). It cannot be used to load ECMAScript modules (although it is possible to.node files are interpreted as compiled addon modules loaded with When resolving a specifier, if no exact match is found, it will try to addĮxtensions (.It is responsible for handling require() calls.Node.js has two systems for resolving a specifier and loading modules. It will also make things easier for build tools and loaders to determine how theįiles in the package should be interpreted. Being explicit about the type of the package willįuture-proof the package in case the default type of Node.js ever changes, and Package authors should include the 'type' field, even in packages whereĪll sources are CommonJS. Via STDIN, with the flag -input-type=commonjs. Strings passed in as an argument to -eval or -print, or piped to node Or when referenced by import statements, import() expressions, orĬontains a top-level field 'type' with a value of 'commonjs'. Will treat the following as CommonJS when passed to node as the initial input, However, now that Node.js supports bothĬommonJS and ES modules, it is best to be explicit whenever possible. Where the nearest parent package.json file contains no top-level 'type'įield, or string input without the flag -input-type. Node.js will treat as CommonJS all other forms of input, such as. Strings passed in as an argument to -eval, or piped to node via STDIN, js extension when the nearest parent package.json fileĬontains a top-level 'type' field with a value of 'module'. Initial input, or when referenced by import statements or import()įiles with a. Node.js will treat the following as ES modules when passed to node as the This page provides guidance for package authors writing package.json filesĪlong with a reference for the package.json fields defined by Node.js. Until the next folder containing another package.json file, or a folder The packageĬonsists of the folder containing the package.json file and all subfolders js file extension via package.json 'type' field.Ī package is a folder tree described by a package.json file. Introduce 'exports' package.json field as a more powerful alternative to the classic 'main' field.Īdd support for ES modules using. Unflag self-referencing a package using its name. In 12.16.0, conditional exports are still behind -experimental-modules.

Remove the -experimental-conditional-exports option.

Nodejs map