docs(types): fix inaccurate jsdoc descriptions and defaults

Author: RihanArfan

src/types/config.ts

@@ -56,8 +56,9 @@ export interface NitroOptions extends PresetOptions {
    *
    * Providers introduce new features that Nitro presets can leverage, but
    * some need to be explicitly opted into. Set to the latest tested date
-   * in `YYYY-MM-DD` format. Defaults to `"latest"` behavior when unset.
+   * in `YYYY-MM-DD` format.
    *
+   * @default "latest"
    * @see https://nitro.build/config#compatibilitydate
    */
   compatibilityDate: CompatibilityDates;
@@ -107,7 +108,8 @@ export interface NitroOptions extends PresetOptions {
    * Server runtime configuration accessible via `useRuntimeConfig()`.
    *
    * Values can be overridden at runtime using environment variables with
-   * the `NITRO_` prefix (configurable via `nitro.envPrefix`).
+   * the `NITRO_` prefix. An alternative prefix can be configured via
+   * `runtimeConfig.nitro.envPrefix` or `NITRO_ENV_PREFIX`.
    *
    * **Note:** The `nitro` namespace is reserved for internal use.
    *
@@ -142,11 +144,12 @@ export interface NitroOptions extends PresetOptions {
 
   /**
    * Server directory for scanning `api/`, `routes/`, `plugins/`, `utils/`,
-   * `middleware/`, `assets/`, and `tasks/` folders.
+   * `middleware/`, `modules/`, and `tasks/` folders.
    *
    * Set to `false` to disable automatic directory scanning, `"./"` to use
    * the root directory, or `"./server"` to use a `server/` subdirectory.
    *
+   * @default false
    * @see https://nitro.build/config#serverdir
    */
   serverDir: string | false;
@@ -380,7 +383,7 @@ export interface NitroOptions extends PresetOptions {
    * @see https://nitro.build/config#future
    */
   future: {
-    /** Use built-in SWR (caching layer + storage) instead of ISR on Netlify and Vercel. */
+    /** Use built-in SWR (caching layer + storage) instead of ISR on Vercel. */
     nativeSWR?: boolean;
   };
 
@@ -407,6 +410,7 @@ export interface NitroOptions extends PresetOptions {
    *
    * Set to `false` to disable auto-imports. Pass an object to customize.
    *
+   * @default false
    * @see https://nitro.build/config#imports
    * @see https://github.com/unjs/unimport
    */
@@ -634,7 +638,8 @@ export interface NitroOptions extends PresetOptions {
   /**
    * Path(s) to custom runtime error handler(s).
    *
-   * Replaces Nitro's built-in error page.
+   * Custom handlers run before the built-in error handler, which is
+   * always added as a fallback.
    *
    * @see https://nitro.build/config#errorhandler
    */
@@ -691,7 +696,9 @@ export interface NitroOptions extends PresetOptions {
   /**
    * Bundler to use for production builds.
    *
-   * Auto-detected when not set.
+   * When not set, defaults to `"vite"` if a `vite.config` with the
+   * `nitro()` plugin is detected, otherwise `"rolldown"`. Can also be
+   * set via the `NITRO_BUILDER` environment variable.
    *
    * @see https://nitro.build/config#builder
    */
@@ -1071,7 +1078,8 @@ export interface NitroRuntimeConfigApp {
  * Server runtime configuration accessible via `useRuntimeConfig()`.
  *
  * Values can be overridden at runtime using environment variables with
- * the `NITRO_` prefix (configurable via `nitro.envPrefix`).
+ * the `NITRO_` prefix. An alternative prefix can be configured via
+ * `nitro.envPrefix` or `NITRO_ENV_PREFIX`.
  *
  * @see https://nitro.build/config#runtimeconfig
  */

src/types/nitro.ts

@@ -77,7 +77,7 @@ export interface NitroFrameworkInfo {
 
 /**
  * Build info written to `.output/nitro.json` (production) or
- * `.nitro/dev/nitro.json` (development).
+ * `node_modules/.nitro/nitro.dev.json` (development).
  *
  * Contains preset, framework, version, and command information.
  */

src/types/route-rules.ts

@@ -22,7 +22,7 @@ export interface NitroRouteConfig {
    * Server-side response caching options.
    *
    * When set to an options object, matching handlers are wrapped with
-   * `defineCachedEventHandler`. Set to `false` to disable caching.
+   * `defineCachedHandler`. Set to `false` to disable caching.
    *
    * @see https://nitro.build/docs/cache
    */

src/types/runtime/nitro.ts

@@ -2,13 +2,26 @@ import type { H3Core, HTTPEvent } from "h3";
 import type { HookableCore } from "hookable";
 import type { ServerRequest } from "srvx";
 
+/**
+ * The runtime Nitro application instance accessible via `useNitroApp()`.
+ *
+ * @see https://nitro.build/docs/plugins
+ */
 export interface NitroApp {
   fetch: (req: Request) => Response | Promise<Response>;
   h3?: H3Core;
   hooks?: HookableCore<NitroRuntimeHooks>;
   captureError?: CaptureError;
 }
 
+/**
+ * A Nitro runtime plugin function.
+ *
+ * Receives the {@link NitroApp} instance (with `hooks` guaranteed to exist)
+ * and can register runtime hooks or modify the app.
+ *
+ * @see https://nitro.build/docs/plugins
+ */
 export interface NitroAppPlugin {
   (
     nitro: NitroApp & {
@@ -38,11 +51,13 @@ export interface RenderContext {
   response?: Partial<RenderResponse>;
 }
 
+/** Context provided when an error is captured at runtime. */
 export interface CapturedErrorContext {
   event?: HTTPEvent;
   tags?: string[];
 }
 
+/** Error capture callback used by `nitroApp.captureError`. */
 export type CaptureError = (error: Error, context: CapturedErrorContext) => void;
 
 /**