node:os

The node:os module in Azion Runtime: the values its functions return inside a function, and a sample that reads the platform name.

Last updated

View as Markdown Agent setup

The node:os module provides operating system utility functions and properties, as the Node.js os documentation describes. In Azion Runtime, import os from "node:os" builds, and every member listed below works without throwing, in a deployed function and under azion dev.

The values are the same in both environments, so they do not identify the machine that runs your code. os.platform() returns linux and os.type() returns Linux. os.homedir() returns /, os.tmpdir() returns /tmp, os.endianness() returns LE, and os.EOL is \n. os.arch(), os.release(), os.hostname(), os.machine(), and os.version() return an empty string, and os.totalmem(), os.freemem(), and os.uptime() return 0. os.availableParallelism() returns 8, os.cpus() returns 8 entries, and os.networkInterfaces() lists one interface, lo0.

Example

The function below reads the platform name, logs it, and returns it in the response body:

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

The function logs Platform linux and responds with this body:

platform: linux
Node.js APIs

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

node:process

The process object, whose platform and architecture properties are also empty.

Use Node.js APIs through polyfills

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

Handlers

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