Add typing

Sytten · Sytten · commit e6d880040b8e · 2024-11-18T23:30:52.000-05:00
diff --git a/types/globals.d.ts b/types/globals.d.ts
@@ -0,0 +1,6 @@
+export {};
+declare global {
+  namespace QuickJS {
+    type Platform = "darwin" | "linux" | "win32";
+  }
+}
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,4 +1,5 @@
 /// <reference path="console.d.ts" />
+/// <reference path="os.d.ts" />
 /// <reference path="sqlite.d.ts" />
 /// <reference path="timers.d.ts" />
 /// <reference path="url.d.ts" />
diff --git a/types/os.d.ts b/types/os.d.ts
@@ -0,0 +1,62 @@
+declare module "os" {
+  /**
+   * Returns the operating system name as returned by [`uname(3)`](https://linux.die.net/man/3/uname). For example, it
+   * returns `'Linux'` on Linux, `'Darwin'` on macOS, and `'Windows_NT'` on Windows.
+   *
+   * See [https://en.wikipedia.org/wiki/Uname#Examples](https://en.wikipedia.org/wiki/Uname#Examples) for additional information
+   * about the output of running [`uname(3)`](https://linux.die.net/man/3/uname) on various operating systems.
+   */
+  export function type(): string;
+
+  /**
+   * Returns the operating system release as a string.
+   *
+   * On POSIX systems, the operating system release is determined by calling [`uname(3)`](https://linux.die.net/man/3/uname). On Windows, `RtlGetVersion()` is used. See
+   * [https://en.wikipedia.org/wiki/Uname#Examples](https://en.wikipedia.org/wiki/Uname#Examples) for more information.
+   */
+  export function release(): string;
+
+  /**
+   * Returns a string identifying the kernel version.
+   *
+   * On POSIX systems, the operating system release is determined by calling [`uname(3)`](https://linux.die.net/man/3/uname). On Windows, `RtlGetVersion()` is used.
+   * See [https://en.wikipedia.org/wiki/Uname#Examples](https://en.wikipedia.org/wiki/Uname#Examples) for more information.
+   */
+  export function version(): string;
+
+  /**
+   * Returns the string path of the current user's home directory.
+   *
+   * On POSIX, it uses the `$HOME` environment variable if defined. Otherwise it
+   * uses the [effective UID](https://en.wikipedia.org/wiki/User_identifier#Effective_user_ID) to look up the user's home directory.
+   *
+   * On Windows, it uses the `USERPROFILE` environment variable if defined.
+   * Otherwise it uses the path to the profile directory of the current user.
+   */
+  export function homedir(): string;
+
+  /**
+   * Returns a string identifying the operating system platform for which
+   * the Node.js binary was compiled. The value is set at compile time.
+   */
+  export function platform(): QuickJS.Platform;
+
+  /**
+   * Returns the operating system's default directory for temporary files as a
+   * string.
+   */
+  export function tmpdir(): string;
+
+  /**
+   * The operating system-specific end-of-line marker.
+   * * `\n` on POSIX
+   * * `\r\n` on Windows
+   */
+  const EOL: string;
+
+  /**
+   * Returns the operating system CPU architecture for which the LLRT binary was compiled.
+   * Possible values are 'arm64', 'x64'. The return value is equivalent to `process.arch`.
+   */
+  export function arch(): string;
+}
