bare-os - npm Package Compare versions

Comparing version 3.8.7 to 3.9.0

binding.c

@@ -8,2 +8,6 @@ #include <assert.h>
 
+#if !defined(BARE_PLATFORM_WIN32)
+#include <unistd.h> // getegid
+#endif
+
 static uv_rwlock_t bare_os_env_lock;
@@ -262,4 +266,25 @@
 
+  size_t argc = 1;
+  js_value_t *argv[1];
+
+  err = js_get_callback_info(env, info, &argc, argv, NULL, NULL);
+  assert(err == 0);
+
+  assert(argc == 0 || argc == 1);
+
+  bool uid_undefined;
+  err = js_is_undefined(env, argv[0], &uid_undefined);
+  assert(err == 0);
+
   uv_passwd_t pwd;
-  err = uv_os_get_passwd(&pwd);
+  if (uid_undefined) {
+    err = uv_os_get_passwd(&pwd);
+  } else {
+    uint32_t uid;
+    err = js_get_value_uint32(env, argv[0], &uid);
+    assert(err == 0);
+
+    err = uv_os_get_passwd2(&pwd, uid);
+  }
+
   if (err != 0) {
@@ -944,2 +969,87 @@ err = js_throw_error(env, uv_err_name(err), uv_strerror(err));
 static js_value_t *
+bare_os_group_info(js_env_t *env, js_callback_info_t *info) {
+  int err;
+
+  size_t argc = 1;
+  js_value_t *argv[1];
+
+  err = js_get_callback_info(env, info, &argc, argv, NULL, NULL);
+  assert(err == 0);
+
+  assert(argc == 0 || argc == 1);
+
+  bool gid_undefined;
+  err = js_is_undefined(env, argv[0], &gid_undefined);
+  assert(err == 0);
+
+  int32_t gid;
+  if (gid_undefined) {
+#if defined(BARE_PLATFORM_WIN32)
+    gid = -1;
+#else
+    gid = getegid();
+#endif
+  } else {
+    err = js_get_value_int32(env, argv[0], &gid);
+    assert(err == 0);
+  }
+
+  js_value_t *result;
+
+  uv_group_t group;
+  err = uv_os_get_group(&group, gid);
+
+  if (err == UV_ENOTSUP) {
+    err = js_get_null(env, &result);
+    assert(err == 0);
+
+    return result;
+  }
+
+  if (err != 0) {
+    err = js_throw_error(env, uv_err_name(err), uv_strerror(err));
+    assert(err == 0);
+
+    return NULL;
+  }
+
+  err = js_create_object(env, &result);
+  assert(err == 0);
+
+  js_value_t *groupname;
+  err = js_create_string_utf8(env, (utf8_t *) group.groupname, strlen(group.groupname), &groupname);
+  assert(err == 0);
+
+  err = js_set_named_property(env, result, "groupname", groupname);
+  assert(err == 0);
+
+  js_value_t *grp_gid;
+  err = js_create_int32(env, group.gid, &grp_gid);
+  assert(err == 0);
+
+  err = js_set_named_property(env, result, "gid", grp_gid);
+  assert(err == 0);
+
+  js_value_t *members;
+  err = js_create_array(env, &members);
+  assert(err == 0);
+
+  for (uint32_t i = 0; group.members[i] != NULL; i++) {
+    js_value_t *member;
+    err = js_create_string_utf8(env, (utf8_t *) group.members[i], strlen(group.members[i]), &member);
+    assert(err == 0);
+
+    err = js_set_element(env, members, i, member);
+    assert(err == 0);
+  }
+
+  err = js_set_named_property(env, result, "members", members);
+  assert(err == 0);
+
+  uv_os_free_group(&group);
+
+  return result;
+}
+
+static js_value_t *
 bare_os_get_env_keys(js_env_t *env, js_callback_info_t *info) {
@@ -1242,2 +1352,3 @@ int err;
   V("networkInterfaces", bare_os_network_interfaces)
+  V("groupInfo", bare_os_group_info)
 #undef V
@@ -1244,0 +1355,0 @@

index.d.ts

@@ -61,4 +61,12 @@ export const constants: {
 
-export function userInfo(): UserInfo
+export function userInfo(uid?: number): UserInfo
 
+export interface GroupInfo {
+  groupname: string
+  gid: number
+  members: string[]
+}
+
+export function groupInfo(gid?: number): GroupInfo | null
+
 export function endianness(): 'LE' | 'BE'
@@ -65,0 +73,0 @@

index.js

@@ -32,2 +32,3 @@ const binding = require('./binding')
 exports.userInfo = binding.userInfo
+exports.groupInfo = binding.groupInfo
 
@@ -34,0 +35,0 @@ exports.networkInterfaces = function networkInterfaces() {

package.json

 {
   "name": "bare-os",
-  "version": "3.8.7",
-  "description": "Operating system utilities for Javascript",
+  "version": "3.9.0",
+  "description": "Operating system utilities for Bare",
   "exports": {
@@ -6,0 +6,0 @@ ".": {

README.md

 # bare-os
 
-Operating system utilities for Javascript.
+Operating system utilities for Bare. The API closely follows that of the Node.js `os` module.
 
@@ -9,4 +9,245 @@ ```
 
+## Usage
+
+```js
+const os = require('bare-os')
+
+console.log(os.platform()) // 'darwin', 'linux', 'win32', ...
+console.log(os.arch()) // 'arm64', 'x64', ...
+console.log(os.homedir())
+console.log(os.tmpdir())
+console.log(os.hostname())
+console.log(os.networkInterfaces())
+```
+
+## API
+
+#### `os.constants`
+
+An object containing the following properties:
+
+- `signals` - Signal constants such as `SIGTERM` and `SIGKILL`.
+- `errnos` - Error number constants.
+- `priority` - Process priority constants.
+
+These are also available as a separate module:
+
+```js
+const constants = require('bare-os/constants')
+```
+
+#### `os.EOL`
+
+The platform-specific end-of-line marker. `'\r\n'` on Windows, `'\n'` everywhere else.
+
+#### `os.devNull`
+
+The platform-specific path to the null device. `'\\\\.\\nul'` on Windows, `'/dev/null'` everywhere else.
+
+#### `const p = os.platform()`
+
+Returns the operating system platform as a string. Possible values include `'android'`, `'darwin'`, `'ios'`, `'linux'`, and `'win32'`.
+
+#### `const a = os.arch()`
+
+Returns the CPU architecture as a string. Possible values include `'arm'`, `'arm64'`, `'ia32'`, and `'x64'`.
+
+#### `const t = os.type()`
+
+Returns the operating system name as returned by `uname(3)`.
+
+#### `const v = os.version()`
+
+Returns the operating system version.
+
+#### `const r = os.release()`
+
+Returns the operating system release.
+
+#### `const m = os.machine()`
+
+Returns the machine type as a string.
+
+#### `const p = os.execPath()`
+
+Returns the absolute path of the executable that started the process.
+
+#### `const id = os.pid()`
+
+Returns the process ID.
+
+#### `const id = os.ppid()`
+
+Returns the parent process ID.
+
+#### `const dir = os.cwd()`
+
+Returns the current working directory.
+
+#### `os.chdir(dir)`
+
+Changes the current working directory to `dir`.
+
+#### `const dir = os.tmpdir()`
+
+Returns the operating system's default directory for temporary files.
+
+#### `const dir = os.homedir()`
+
+Returns the home directory of the current user.
+
+#### `const name = os.hostname()`
+
+Returns the hostname of the operating system.
+
+#### `const interfaces = os.networkInterfaces()`
+
+Returns an object containing network interfaces that have been assigned a network address. Each key on the returned object identifies a network interface. The associated value is an array of objects with the following properties:
+
+- `address` - The assigned IPv4 or IPv6 address.
+- `netmask` - The IPv4 or IPv6 network mask.
+- `family` - Either `'IPv4'` or `'IPv6'`.
+- `cidr` - The assigned IPv4 or IPv6 address with the routing prefix in CIDR notation.
+- `mac` - The MAC address of the network interface.
+- `internal` - `true` if the network interface is a loopback or similar interface that is not remotely accessible; otherwise `false`.
+- `scopeid` - The numeric IPv6 scope ID. Only specified when `family` is `'IPv6'`.
+
+#### `os.kill(pid[, signal])`
+
+Sends `signal` to the process identified by `pid`. `signal` can be a string or a number. Defaults to `'SIGTERM'`.
+
+#### `const info = os.userInfo([uid])`
+
+Returns information about a current user. The `uid` value defaults to the current effective uid. The returned object has the following properties:
+
+- `uid` - The user ID.
+- `gid` - The group ID.
+- `username` - The username.
+- `homedir` - The home directory.
+- `shell` - The shell, or `null` if unavailable.
+
+#### `const info = os.groupInfo([gid])`
+
+Returns information about a group. The `gid` value defaults to the effective group ID of the calling process. The returned object has the following properties:
+
+- `groupname` - The group name.
+- `gid` - The group ID.
+- `members` - List with the names of group members.
+
+#### `const e = os.endianness()`
+
+Returns `'LE'` on little-endian systems and `'BE'` on big-endian systems.
+
+#### `const n = os.availableParallelism()`
+
+Returns the number of logical CPU cores available to the process.
+
+#### `const usage = os.cpuUsage([previous])`
+
+Returns an object with `user` and `system` properties, each representing CPU time in microseconds. If `previous` is provided, the returned values are relative to it.
+
+#### `const usage = os.threadCpuUsage([previous])`
+
+Like `os.cpuUsage()` but for the current thread only.
+
+#### `const usage = os.resourceUsage()`
+
+Returns an object describing the resource usage of the current process. The returned object has the following properties:
+
+- `userCPUTime` - User CPU time in microseconds.
+- `systemCPUTime` - System CPU time in microseconds.
+- `maxRSS` - Maximum resident set size in bytes.
+- `sharedMemorySize` - Shared memory size.
+- `unsharedDataSize` - Unshared data size.
+- `unsharedStackSize` - Unshared stack size.
+- `minorPageFault` - Minor page faults.
+- `majorPageFault` - Major page faults.
+- `swappedOut` - Swap count.
+- `fsRead` - File system reads.
+- `fsWrite` - File system writes.
+- `ipcSent` - IPC messages sent.
+- `ipcReceived` - IPC messages received.
+- `signalsCount` - Signals received.
+- `voluntaryContextSwitches` - Voluntary context switches.
+- `involuntaryContextSwitches` - Involuntary context switches.
+
+#### `const usage = os.memoryUsage()`
+
+Returns an object describing the memory usage of the process. The returned object has the following properties:
+
+- `rss` - Resident set size in bytes.
+- `heapTotal` - Total heap size in bytes.
+- `heapUsed` - Used heap size in bytes.
+- `external` - Memory usage of C++ objects bound to JavaScript objects.
+
+#### `const bytes = os.freemem()`
+
+Returns the amount of free system memory in bytes.
+
+#### `const bytes = os.totalmem()`
+
+Returns the total amount of system memory in bytes.
+
+#### `const bytes = os.availableMemory()`
+
+Returns an estimate of the amount of memory available for the process in bytes.
+
+#### `const bytes = os.constrainedMemory()`
+
+Returns the amount of memory available to the process under resource constraints, such as cgroups.
+
+#### `const seconds = os.uptime()`
+
+Returns the system uptime in seconds.
+
+#### `const avgs = os.loadavg()`
+
+Returns an array containing the 1, 5, and 15 minute load averages.
+
+#### `const list = os.cpus()`
+
+Returns an array of objects describing each logical CPU core. Each object has the following properties:
+
+- `model` - The CPU model.
+- `speed` - The CPU speed in MHz.
+- `times` - An object with `user`, `nice`, `sys`, `idle`, and `irq` CPU time values in milliseconds.
+
+#### `const title = os.getProcessTitle()`
+
+Returns the current process title.
+
+#### `os.setProcessTitle(title)`
+
+Sets the process title. `title` is coerced to a string and must be shorter than 256 characters.
+
+#### `const priority = os.getPriority([pid])`
+
+Returns the scheduling priority of the process specified by `pid`. Defaults to `0`, meaning the current process.
+
+#### `os.setPriority([pid, ]priority)`
+
+Sets the scheduling priority of the process specified by `pid`. If `pid` is omitted, the priority of the current process is set.
+
+#### `const keys = os.getEnvKeys()`
+
+Returns an array of the names of all environment variables.
+
+#### `const value = os.getEnv(name)`
+
+Returns the value of the environment variable `name`, or `undefined` if it is not set.
+
+#### `const exists = os.hasEnv(name)`
+
+Returns `true` if the environment variable `name` is set, otherwise `false`.
+
+#### `os.setEnv(name, value)`
+
+Sets the environment variable `name` to `value`.
+
+#### `os.unsetEnv(name)`
+
+Removes the environment variable `name`.
+
 ## License
 
 Apache-2.0

New alerts

AI-detected potential code anomaly

Supply chain risk

AI has identified unusual behaviors that may pose a security risk.

Improved metrics

Total package byte prevSize

920896

2.49%

Lines of code

230

3.14%

Number of lines in readme file

253

2008.33%

Worsened metrics

Number of low supply chain risk alerts

1

Infinity%

No dependency changes