Skip to main content


Deno standard library
Go to Latest
// Copyright Joyent, Inc. and other Node contributors.//// Permission is hereby granted, free of charge, to any person obtaining a// copy of this software and associated documentation files (the// "Software"), to deal in the Software without restriction, including// without limitation the rights to use, copy, modify, merge, publish,// distribute, sublicense, and/or sell copies of the Software, and to permit// persons to whom the Software is furnished to do so, subject to the// following conditions://// The above copyright notice and this permission notice shall be included// in all copies or substantial portions of the Software.//// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE// USE OR OTHER DEALINGS IN THE SOFTWARE.import { notImplemented } from "./_utils.ts";import { validateIntegerRange } from "./_utils.ts";import { EOL as fsEOL } from "../fs/eol.ts";import process from "./process.ts";
const SEE_GITHUB_ISSUE = "See";
interface CPUTimes { /** The number of milliseconds the CPU has spent in user mode */ user: number;
/** The number of milliseconds the CPU has spent in nice mode */ nice: number;
/** The number of milliseconds the CPU has spent in sys mode */ sys: number;
/** The number of milliseconds the CPU has spent in idle mode */ idle: number;
/** The number of milliseconds the CPU has spent in irq mode */ irq: number;}
interface CPUCoreInfo { model: string;
/** in MHz */ speed: number;
times: CPUTimes;}
interface NetworkAddress { /** The assigned IPv4 or IPv6 address */ address: string;
/** The IPv4 or IPv6 network mask */ netmask: string;
family: "IPv4" | "IPv6";
/** The MAC address of the network interface */ mac: string;
/** true if the network interface is a loopback or similar interface that is not remotely accessible; otherwise false */ internal: boolean;
/** The numeric IPv6 scope ID (only specified when family is IPv6) */ scopeid?: number;
/** The assigned IPv4 or IPv6 address with the routing prefix in CIDR notation. If the netmask is invalid, this property is set to null. */ cidr: string;}
interface NetworkInterfaces { [key: string]: NetworkAddress[];}
export interface UserInfoOptions { encoding: string;}
interface UserInfo { username: string; uid: number; gid: number; shell: string; homedir: string;}
arch[Symbol.toPrimitive] = (): string => arch();endianness[Symbol.toPrimitive] = (): string => endianness();freemem[Symbol.toPrimitive] = (): number => freemem();homedir[Symbol.toPrimitive] = (): string | null => homedir();hostname[Symbol.toPrimitive] = (): string | null => hostname();platform[Symbol.toPrimitive] = (): string => platform();release[Symbol.toPrimitive] = (): string => release();totalmem[Symbol.toPrimitive] = (): number => totalmem();type[Symbol.toPrimitive] = (): string => type();uptime[Symbol.toPrimitive] = (): number => uptime();
/** Returns the operating system CPU architecture for which the Deno binary was compiled */export function arch(): string { return;}
/** Not yet implemented */export function cpus(): CPUCoreInfo[] { notImplemented(SEE_GITHUB_ISSUE);}
/** * Returns a string identifying the endianness of the CPU for which the Deno * binary was compiled. Possible values are 'BE' for big endian and 'LE' for * little endian. **/export function endianness(): "BE" | "LE" { // Source: const buffer = new ArrayBuffer(2); new DataView(buffer).setInt16(0, 256, true /* littleEndian */); // Int16Array uses the platform's endianness. return new Int16Array(buffer)[0] === 256 ? "LE" : "BE";}
/** Return free memory amount */export function freemem(): number { return Deno.systemMemoryInfo().free;}
/** Not yet implemented */export function getPriority(pid = 0): number { validateIntegerRange(pid, "pid"); notImplemented(SEE_GITHUB_ISSUE);}
/** Returns the string path of the current user's home directory. */export function homedir(): string | null { notImplemented(SEE_GITHUB_ISSUE);}
/** Returns the host name of the operating system as a string. */export function hostname(): string { notImplemented(SEE_GITHUB_ISSUE);}
/** Returns an array containing the 1, 5, and 15 minute load averages */export function loadavg(): number[] { if ( === "windows") { return [0, 0, 0]; } return Deno.loadavg();}
/** Not yet implemented */export function networkInterfaces(): NetworkInterfaces { notImplemented(SEE_GITHUB_ISSUE);}/** Returns the a string identifying the operating system platform. The value is set at compile time. Possible values are 'darwin', 'linux', and 'win32'. */export function platform(): string { return process.platform;}
/** Returns the operating system as a string */export function release(): string { return Deno.osRelease();}
/** Not yet implemented */export function setPriority(pid: number, priority?: number): void { /* The node API has the 'pid' as the first parameter and as optional. This makes for a problematic implementation in Typescript. */ if (priority === undefined) { priority = pid; pid = 0; } validateIntegerRange(pid, "pid"); validateIntegerRange(priority, "priority", -20, 19);
/** Returns the operating system's default directory for temporary files as a string. */export function tmpdir(): string | null { notImplemented(SEE_GITHUB_ISSUE);}
/** Return total physical memory amount */export function totalmem(): number { return Deno.systemMemoryInfo().total;}
/** Not yet implemented */export function type(): string { notImplemented(SEE_GITHUB_ISSUE);}
/** Not yet implemented */export function uptime(): number { notImplemented(SEE_GITHUB_ISSUE);}
/** Not yet implemented */export function userInfo( options: UserInfoOptions = { encoding: "utf-8" },): UserInfo { notImplemented(SEE_GITHUB_ISSUE);}
export const constants = { // UV_UDP_REUSEADDR: 4, //see dlopen: { // see }, errno: { // see }, signals: Deno.Signal, priority: { // see },};
export const EOL = == "windows" ? fsEOL.CRLF : fsEOL.LF;
export default { arch, cpus, endianness, freemem, getPriority, homedir, hostname, loadavg, networkInterfaces, platform, release, setPriority, tmpdir, totalmem, type, uptime, userInfo, constants, EOL,};