chore: update jsdocs

Author: pi0

README.md

@@ -32,7 +32,7 @@ Detects the current CI/CD provider based on environment variables.
 import { isCI, provider, providerInfo } from "std-env";
 
 console.log({ isCI, provider, providerInfo });
-// { isCI: true, provider: "github_actions", providerInfo: { name: "github_actions", isCI: true } }
+// { isCI: true, provider: "github_actions", providerInfo: { name: "github_actions", ci: true } }
 ```
 
 Use `detectProvider()` to re-run detection. See [./src/providers.ts](./src/providers.ts) for the full list.
@@ -58,32 +58,33 @@ Supported agents: `cursor`, `claude`, `devin`, `replit`, `gemini`, `codex`, `aug
 import { env, isDevelopment, isProduction } from "std-env";
 ```
 
-| Export             | Description                               |
-| ------------------ | ----------------------------------------- |
-| `hasTTY`           | stdout TTY is available                   |
-| `hasWindow`        | Global `window` is available              |
-| `isCI`             | Running in CI                             |
-| `isColorSupported` | Terminal color output supported           |
-| `isDebug`          | `DEBUG` env var is set                    |
-| `isDevelopment`    | `NODE_ENV` is `dev` or `development`      |
-| `isLinux`          | Linux platform                            |
-| `isMacOS`          | macOS (darwin) platform                   |
-| `isMinimal`        | Minimal environment (CI, test, or no TTY) |
-| `isProduction`     | `NODE_ENV` is `production`                |
-| `isTest`           | `NODE_ENV` is `test`                      |
-| `isWindows`        | Windows platform                          |
-| `platform`         | Value of `process.platform`               |
-| `nodeVersion`      | Node.js version string (e.g. `"22.0.0"`)  |
-| `nodeMajorVersion` | Node.js major version number (e.g. `22`)  |
+| Export             | Description                                                  |
+| ------------------ | ------------------------------------------------------------ |
+| `hasTTY`           | stdout TTY is available                                      |
+| `hasWindow`        | Global `window` is available                                 |
+| `isCI`             | Running in CI                                                |
+| `isColorSupported` | Terminal color output supported                              |
+| `isDebug`          | `DEBUG` env var is set                                       |
+| `isDevelopment`    | `NODE_ENV` is `dev`/`development` or `MODE` is `development` |
+| `isLinux`          | Linux platform                                               |
+| `isMacOS`          | macOS (darwin) platform                                      |
+| `isMinimal`        | `MINIMAL` env is set, CI, test, or no TTY                    |
+| `isProduction`     | `NODE_ENV` or `MODE` is `production`                         |
+| `isTest`           | `NODE_ENV` is `test` or `TEST` env is set                    |
+| `isWindows`        | Windows platform                                             |
+| `platform`         | Value of `process.platform`                                  |
+| `nodeVersion`      | Node.js version string (e.g. `"22.0.0"`)                     |
+| `nodeMajorVersion` | Node.js major version number (e.g. `22`)                     |
 
 See [./src/flags.ts](./src/flags.ts) for details.
 
 ## Environment
 
-| Export    | Description                                         |
-| --------- | --------------------------------------------------- |
-| `env`     | Universal `process.env` (works across all runtimes) |
-| `nodeENV` | Current `NODE_ENV` value (undefined if unset)       |
+| Export    | Description                                          |
+| --------- | ---------------------------------------------------- |
+| `env`     | Universal `process.env` (works across all runtimes)  |
+| `process` | Universal `process` shim (works across all runtimes) |
+| `nodeENV` | Current `NODE_ENV` value (undefined if unset)        |
 
 ## License
 

src/agents.ts

@@ -2,6 +2,9 @@
 
 import { env } from "./env.ts";
 
+/**
+ * Represents the name of an AI coding agent.
+ */
 export type AgentName =
   | (string & {})
   | "cursor"

src/env.ts

@@ -1,6 +1,16 @@
+/**
+ * Runtime-agnostic reference to environment variables.
+ *
+ * Resolves to `globalThis.process.env` when available, otherwise an empty object.
+ */
 export const env: Record<string, string | undefined> =
   globalThis.process?.env || Object.create(null);
 
+/**
+ * Runtime-agnostic reference to the `process` global.
+ *
+ * Resolves to `globalThis.process` when available, otherwise a minimal shim containing only `env`.
+ */
 export const process: Partial<typeof globalThis.process> = globalThis.process || { env };
 
 /**

src/flags.ts

@@ -39,11 +39,12 @@ export const isLinux: boolean = /^linux/i.test(platform);
 /** Detect if process.platform is macOS (darwin kernel) */
 export const isMacOS: boolean = /^darwin/i.test(platform);
 
-/** Color Support */
+/** Detect if terminal color output is supported based on `NO_COLOR`, `FORCE_COLOR`, TTY, and CI environment */
 export const isColorSupported: boolean =
   !env.NO_COLOR && (!!env.FORCE_COLOR || ((hasTTY || isWindows) && env.TERM !== "dumb") || isCI);
 
-/** Node.js versions */
+/** Node.js version string (e.g. `"20.11.0"`), or `null` if not running in Node.js */
 export const nodeVersion: string | null = (process.versions?.node || "").replace(/^v/, "") || null;
 
+/** Node.js major version number (e.g. `20`), or `null` if not running in Node.js */
 export const nodeMajorVersion: number | null = Number(nodeVersion?.split(".")[0]) || null;

src/runtimes.ts

@@ -1,6 +1,10 @@
 import { process } from "./env.ts";
 
-// https://runtime-keys.proposal.wintercg.org/
+/**
+ * Represents the name of a JavaScript runtime.
+ *
+ * @see https://runtime-keys.proposal.wintercg.org/
+ */
 export type RuntimeName =
   | (string & {})
   | "workerd"
@@ -48,7 +52,6 @@ export const isFastly: boolean = "fastly" in globalThis;
 export const isNetlify: boolean = "Netlify" in globalThis;
 
 /**
- *
  * Indicates if running in EdgeLight (Vercel Edge) runtime.
  */
 export const isEdgeLight: boolean = "EdgeRuntime" in globalThis;