Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

std/node/process.ts

Deno standard library
Go to Latest
The Standard Library has been moved to JSR. See the blog post for details.
File
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.// Copyright Joyent, Inc. and Node.js contributors. All rights reserved. MIT license.
import { notImplemented, warnNotImplemented } from "./_utils.ts";import { EventEmitter } from "./events.ts";import { validateString } from "./internal/validators.mjs";import { ERR_INVALID_ARG_TYPE, ERR_UNKNOWN_SIGNAL, errnoException,} from "./internal/errors.ts";import { getOptionValue } from "./internal/options.ts";import { assert } from "../_util/asserts.ts";import { fromFileUrl, join } from "../path/mod.ts";import { arch, chdir, cwd, env, nextTick as _nextTick, pid, platform, version, versions,} from "./_process/process.ts";import { _exiting } from "./_process/exiting.ts";export { _nextTick as nextTick, arch, argv, chdir, cwd, env, pid, platform, version, versions,};import { stderr as stderr_, stdin as stdin_, stdout as stdout_,} from "./_process/streams.mjs";import { core } from "./_core.ts";import { processTicksAndRejections } from "./_next_tick.ts";
// TODO(kt3k): Give better types to stdio objects// deno-lint-ignore no-explicit-anyconst stderr = stderr_ as any;// deno-lint-ignore no-explicit-anyconst stdin = stdin_ as any;// deno-lint-ignore no-explicit-anyconst stdout = stdout_ as any;export { stderr, stdin, stdout };import { getBinding } from "./internal_binding/mod.ts";import * as constants from "./internal_binding/constants.ts";import * as uv from "./internal_binding/uv.ts";import type { BindingName } from "./internal_binding/mod.ts";import { buildAllowedFlags } from "./internal/process/per_thread.mjs";
// @ts-ignore Deno[Deno.internal] is used on purpose hereconst DenoCommand = Deno[Deno.internal]?.nodeUnstable?.Command || Deno.Command;
const notImplementedEvents = [ "disconnect", "message", "multipleResolves", "rejectionHandled", "worker",];
// The first 2 items are placeholders.// They will be overwritten by the below Object.defineProperty calls.const argv = ["", "", ...Deno.args];// Overwrites the 1st item with getter.Object.defineProperty(argv, "0", { get: Deno.execPath });// Overwrites the 2st item with getter.Object.defineProperty(argv, "1", { get: () => { if (Deno.mainModule.startsWith("file:")) { return fromFileUrl(Deno.mainModule); } else { return join(Deno.cwd(), "$deno$node.js"); } },});
/** https://nodejs.org/api/process.html#process_process_exit_code */export const exit = (code?: number | string) => { if (code || code === 0) { if (typeof code === "string") { const parsedCode = parseInt(code); process.exitCode = isNaN(parsedCode) ? undefined : parsedCode; } else { process.exitCode = code; } }
if (!process._exiting) { process._exiting = true; // FIXME(bartlomieju): this is wrong, we won't be using syscall to exit // and thus the `unload` event will not be emitted to properly trigger "emit" // event on `process`. process.emit("exit", process.exitCode || 0); }
Deno.exit(process.exitCode || 0);};
function addReadOnlyProcessAlias( name: string, option: string, enumerable = true,) { const value = getOptionValue(option);
if (value) { Object.defineProperty(process, name, { writable: false, configurable: true, enumerable, value, }); }}
function createWarningObject( warning: string, type: string, code?: string, // deno-lint-ignore ban-types ctor?: Function, detail?: string,): Error { assert(typeof warning === "string");
// deno-lint-ignore no-explicit-any const warningErr: any = new Error(warning); warningErr.name = String(type || "Warning");
if (code !== undefined) { warningErr.code = code; } if (detail !== undefined) { warningErr.detail = detail; }
// @ts-ignore this function is not available in lib.dom.d.ts Error.captureStackTrace(warningErr, ctor || process.emitWarning);
return warningErr;}
function doEmitWarning(warning: Error) { process.emit("warning", warning);}
/** https://nodejs.org/api/process.html#process_process_emitwarning_warning_options */export function emitWarning( warning: string | Error, type: // deno-lint-ignore ban-types | { type: string; detail: string; code: string; ctor: Function } | string | null, code?: string, // deno-lint-ignore ban-types ctor?: Function,) { let detail;
if (type !== null && typeof type === "object" && !Array.isArray(type)) { ctor = type.ctor; code = type.code;
if (typeof type.detail === "string") { detail = type.detail; }
type = type.type || "Warning"; } else if (typeof type === "function") { ctor = type; code = undefined; type = "Warning"; }
if (type !== undefined) { validateString(type, "type"); }
if (typeof code === "function") { ctor = code; code = undefined; } else if (code !== undefined) { validateString(code, "code"); }
if (typeof warning === "string") { warning = createWarningObject(warning, type as string, code, ctor, detail); } else if (!(warning instanceof Error)) { throw new ERR_INVALID_ARG_TYPE("warning", ["Error", "string"], warning); }
if (warning.name === "DeprecationWarning") { // deno-lint-ignore no-explicit-any if ((process as any).noDeprecation) { return; }
// deno-lint-ignore no-explicit-any if ((process as any).throwDeprecation) { // Delay throwing the error to guarantee that all former warnings were // properly logged. return process.nextTick(() => { throw warning; }); } }
process.nextTick(doEmitWarning, warning);}
export function hrtime(time?: [number, number]): [number, number] { const milli = performance.now(); const sec = Math.floor(milli / 1000); const nano = Math.floor(milli * 1_000_000 - sec * 1_000_000_000); if (!time) { return [sec, nano]; } const [prevSec, prevNano] = time; return [sec - prevSec, nano - prevNano];}
hrtime.bigint = function (): BigInt { const [sec, nano] = hrtime(); return BigInt(sec) * 1_000_000_000n + BigInt(nano);};
export function memoryUsage(): { rss: number; heapTotal: number; heapUsed: number; external: number; arrayBuffers: number;} { return { ...Deno.memoryUsage(), arrayBuffers: 0, };}
memoryUsage.rss = function (): number { return memoryUsage().rss;};
// Returns a negative error code than can be recognized by errnoExceptionfunction _kill(pid: number, sig: number): number { let errCode;
if (sig === 0) { let status; if (Deno.build.os === "windows") { status = (new DenoCommand("powershell.exe", { args: ["Get-Process", "-pid", pid], })).outputSync(); } else { status = (new DenoCommand("kill", { args: ["-0", pid], })).outputSync(); }
if (!status.success) { errCode = uv.codeMap.get("ESRCH"); } } else { // Reverse search the shortname based on the numeric code const maybeSignal = Object.entries(constants.os.signals).find(( [_, numericCode], ) => numericCode === sig);
if (!maybeSignal) { errCode = uv.codeMap.get("EINVAL"); } else { try { Deno.kill(pid, maybeSignal[0] as Deno.Signal); } catch (e) { if (e instanceof TypeError) { throw notImplemented(maybeSignal[0]); }
throw e; } } }
if (!errCode) { return 0; } else { return errCode; }}
export function kill(pid: number, sig: string | number = "SIGTERM") { if (pid != (pid | 0)) { throw new ERR_INVALID_ARG_TYPE("pid", "number", pid); }
let err; if (typeof sig === "number") { err = process._kill(pid, sig); } else { if (sig in constants.os.signals) { // @ts-ignore Index previously checked err = process._kill(pid, constants.os.signals[sig]); } else { throw new ERR_UNKNOWN_SIGNAL(sig); } }
if (err) { throw errnoException(err, "kill"); }
return true;}
// deno-lint-ignore no-explicit-anyfunction uncaughtExceptionHandler(err: any, origin: string) { // The origin parameter can be 'unhandledRejection' or 'uncaughtException' // depending on how the uncaught exception was created. In Node.js, // exceptions thrown from the top level of a CommonJS module are reported as // 'uncaughtException', while exceptions thrown from the top level of an ESM // module are reported as 'unhandledRejection'. Deno does not have a true // CommonJS implementation, so all exceptions thrown from the top level are // reported as 'uncaughtException'. process.emit("uncaughtExceptionMonitor", err, origin); process.emit("uncaughtException", err, origin);}
let execPath: string | null = null;
class Process extends EventEmitter { constructor() { super();
globalThis.addEventListener("unhandledrejection", (event) => { if (process.listenerCount("unhandledRejection") === 0) { // The Node.js default behavior is to raise an uncaught exception if // an unhandled rejection occurs and there are no unhandledRejection // listeners. if (process.listenerCount("uncaughtException") === 0) { throw event.reason; }
event.preventDefault(); uncaughtExceptionHandler(event.reason, "unhandledRejection"); return; }
event.preventDefault(); process.emit("unhandledRejection", event.reason, event.promise); });
globalThis.addEventListener("error", (event) => { if (process.listenerCount("uncaughtException") > 0) { event.preventDefault(); }
uncaughtExceptionHandler(event.error, "uncaughtException"); });
globalThis.addEventListener("beforeunload", (e) => { super.emit("beforeExit", process.exitCode || 0); processTicksAndRejections(); if (core.eventLoopHasMoreWork()) { e.preventDefault(); } });
globalThis.addEventListener("unload", () => { if (!process._exiting) { process._exiting = true; super.emit("exit", process.exitCode || 0); } }); }
/** https://nodejs.org/api/process.html#process_process_arch */ arch = arch;
/** * https://nodejs.org/api/process.html#process_process_argv * Read permissions are required in order to get the executable route */ argv = argv;
/** https://nodejs.org/api/process.html#process_process_chdir_directory */ chdir = chdir;
/** https://nodejs.org/api/process.html#processconfig */ config = { target_defaults: {}, variables: {}, };
/** https://nodejs.org/api/process.html#process_process_cwd */ cwd = cwd;
/** * https://nodejs.org/api/process.html#process_process_env * Requires env permissions */ env = env;
/** https://nodejs.org/api/process.html#process_process_execargv */ execArgv: string[] = [];
/** https://nodejs.org/api/process.html#process_process_exit_code */ exit = exit;
_exiting = _exiting;
/** https://nodejs.org/api/process.html#processexitcode_1 */ exitCode: undefined | number = undefined;
// Typed as any to avoid importing "module" module for types // deno-lint-ignore no-explicit-any mainModule: any = undefined;
/** https://nodejs.org/api/process.html#process_process_nexttick_callback_args */ nextTick = _nextTick;
/** https://nodejs.org/api/process.html#process_process_events */ override on(event: "exit", listener: (code: number) => void): this; override on( event: typeof notImplementedEvents[number], // deno-lint-ignore ban-types listener: Function, ): this; // deno-lint-ignore no-explicit-any override on(event: string, listener: (...args: any[]) => void): this { if (notImplementedEvents.includes(event)) { warnNotImplemented(`process.on("${event}")`); super.on(event, listener); } else if (event.startsWith("SIG")) { if (event === "SIGBREAK" && Deno.build.os !== "windows") { // Ignores SIGBREAK if the platform is not windows. } else if (event === "SIGTERM" && Deno.build.os === "windows") { // Ignores SIGTERM on windows. } else { Deno.addSignalListener(event as Deno.Signal, listener); } } else { super.on(event, listener); }
return this; }
override off(event: "exit", listener: (code: number) => void): this; override off( event: typeof notImplementedEvents[number], // deno-lint-ignore ban-types listener: Function, ): this; // deno-lint-ignore no-explicit-any override off(event: string, listener: (...args: any[]) => void): this { if (notImplementedEvents.includes(event)) { warnNotImplemented(`process.off("${event}")`); super.off(event, listener); } else if (event.startsWith("SIG")) { if (event === "SIGBREAK" && Deno.build.os !== "windows") { // Ignores SIGBREAK if the platform is not windows. } else if (event === "SIGTERM" && Deno.build.os === "windows") { // Ignores SIGTERM on windows. } else { Deno.removeSignalListener(event as Deno.Signal, listener); } } else { super.off(event, listener); }
return this; }
// deno-lint-ignore no-explicit-any override emit(event: string, ...args: any[]): boolean { if (event.startsWith("SIG")) { if (event === "SIGBREAK" && Deno.build.os !== "windows") { // Ignores SIGBREAK if the platform is not windows. } else { Deno.kill(Deno.pid, event as Deno.Signal); } } else { return super.emit(event, ...args); }
return true; }
override prependListener( event: "exit", listener: (code: number) => void, ): this; override prependListener( event: typeof notImplementedEvents[number], // deno-lint-ignore ban-types listener: Function, ): this; override prependListener( event: string, // deno-lint-ignore no-explicit-any listener: (...args: any[]) => void, ): this { if (notImplementedEvents.includes(event)) { warnNotImplemented(`process.prependListener("${event}")`); super.prependListener(event, listener); } else if (event.startsWith("SIG")) { if (event === "SIGBREAK" && Deno.build.os !== "windows") { // Ignores SIGBREAK if the platform is not windows. } else { Deno.addSignalListener(event as Deno.Signal, listener); } } else { super.prependListener(event, listener); }
return this; }
/** https://nodejs.org/api/process.html#process_process_pid */ pid = pid;
/** https://nodejs.org/api/process.html#process_process_platform */ platform = platform;
override addListener(event: "exit", listener: (code: number) => void): this; override addListener( event: typeof notImplementedEvents[number], // deno-lint-ignore ban-types listener: Function, ): this; override addListener( event: string, // deno-lint-ignore no-explicit-any listener: (...args: any[]) => void, ): this { if (notImplementedEvents.includes(event)) { warnNotImplemented(`process.addListener("${event}")`); }
return this.on(event, listener); }
override removeListener( event: "exit", listener: (code: number) => void, ): this; override removeListener( event: typeof notImplementedEvents[number], // deno-lint-ignore ban-types listener: Function, ): this; override removeListener( event: string, // deno-lint-ignore no-explicit-any listener: (...args: any[]) => void, ): this { if (notImplementedEvents.includes(event)) { warnNotImplemented(`process.removeListener("${event}")`); }
return this.off(event, listener); }
/** * Returns the current high-resolution real time in a [seconds, nanoseconds] * tuple. * * Note: You need to give --allow-hrtime permission to Deno to actually get * nanoseconds precision values. If you don't give 'hrtime' permission, the returned * values only have milliseconds precision. * * `time` is an optional parameter that must be the result of a previous process.hrtime() call to diff with the current time. * * These times are relative to an arbitrary time in the past, and not related to the time of day and therefore not subject to clock drift. The primary use is for measuring performance between intervals. * https://nodejs.org/api/process.html#process_process_hrtime_time */ hrtime = hrtime;
/** * @private * * NodeJS internal, use process.kill instead */ _kill = _kill;
/** https://nodejs.org/api/process.html#processkillpid-signal */ kill = kill;
memoryUsage = memoryUsage;
/** https://nodejs.org/api/process.html#process_process_stderr */ stderr = stderr;
/** https://nodejs.org/api/process.html#process_process_stdin */ stdin = stdin;
/** https://nodejs.org/api/process.html#process_process_stdout */ stdout = stdout;
/** https://nodejs.org/api/process.html#process_process_version */ version = version;
/** https://nodejs.org/api/process.html#process_process_versions */ versions = versions;
/** https://nodejs.org/api/process.html#process_process_emitwarning_warning_options */ emitWarning = emitWarning;
binding(name: BindingName) { return getBinding(name); }
/** https://nodejs.org/api/process.html#processumaskmask */ umask() { // Always return the system default umask value. // We don't use Deno.umask here because it has a race // condition bug. // See https://github.com/denoland/deno_std/issues/1893#issuecomment-1032897779 return 0o22; }
/** This method is removed on Windows */ getgid?(): number { return Deno.gid()!; }
/** This method is removed on Windows */ getuid?(): number { return Deno.uid()!; }
// TODO(kt3k): Implement this when we added -e option to node compat mode _eval: string | undefined = undefined;
/** https://nodejs.org/api/process.html#processexecpath */ get execPath() { if (execPath) { return execPath; } execPath = Deno.execPath(); return execPath; }
set execPath(path: string) { execPath = path; }
#startTime = Date.now(); /** https://nodejs.org/api/process.html#processuptime */ uptime() { return (Date.now() - this.#startTime) / 1000; }
#allowedFlags = buildAllowedFlags(); /** https://nodejs.org/api/process.html#processallowednodeenvironmentflags */ get allowedNodeEnvironmentFlags() { return this.#allowedFlags; }
features = { inspector: false };
// TODO(kt3k): Get the value from --no-deprecation flag. noDeprecation = false;}
if (Deno.build.os === "windows") { delete Process.prototype.getgid; delete Process.prototype.getuid;}
/** https://nodejs.org/api/process.html#process_process */const process = new Process();
Object.defineProperty(process, Symbol.toStringTag, { enumerable: false, writable: true, configurable: false, value: "process",});
addReadOnlyProcessAlias("noDeprecation", "--no-deprecation");addReadOnlyProcessAlias("throwDeprecation", "--throw-deprecation");
export const removeListener = process.removeListener;export const removeAllListeners = process.removeAllListeners;
export default process;
//TODO(Soremwar)//Remove on 1.0//Kept for backwards compatibility with stdexport { process };