node:module

The node:module module in Azion Runtime: what its members return inside a function, and a sample that lists the built-in module names.

Last updated

View as Markdown Agent setup

The node:module module gives access to the Node.js module system, which covers CommonJS and ES modules, as the Node.js module documentation describes. In Node.js, the module system organizes code into reusable files and libraries. In Azion Runtime, import module from "node:module" builds, and you use it to inspect the module system, for example to list the built-in modules a function can import.

The members below behave the same in a deployed function and under azion dev. module.builtinModules is an array of 65 names, from _http_agent to zlib. module.createRequire() returns undefined instead of a require function, so a call to its result throws a TypeError. module.isBuiltin() does not exist. SourceMap, _findPath, _initPaths, _load, _nodeModulePaths, _preloadModules, _resolveFilename, and _resolveLookupPaths are not supported.

Example

The function below logs the name of every built-in module and responds when the list ends:

JavaScript
01/**
02 * An example of using the Node.js Module API in an Azion Function.
03 * @example
04 * // Build and run locally with the Azion CLI:
05 * azion build
06 * azion dev
07 */
08import module from "node:module";
09
10/**
11 * An example of using the Node.js Module API in an Azion Function.
12 * @param {*} event
13 * @returns {Promise<Response>}
14 */
15const main = async (event) => {
16 return new Promise((resolve, reject) => {
17 module.builtinModules.forEach((moduleName) => {
18 console.log(moduleName);
19 });
20 resolve(new Response("Done"));
21 });
22};
23
24export default main;

The function logs the 65 names, one per line, from _http_agent to zlib, and responds with this body:

Done
Node.js APIs

Every Node.js module Azion Runtime resolves, and how each one behaves.

Use Node.js APIs through polyfills

How the build resolves Node.js APIs through polyfills, shown in a JavaScript project.

Azion CLI build

The command that builds a project on your machine and writes the result to the .edge folder.

Handlers

The recommended handler shape, and the notice azion build prints for the export default main shape this sample uses.