chore: add jsdoc to output in next.config.js (#46804)

- Follow up to #46744
vercel · Mar 5, 2023 · 4c723f4 · 4c723f4
1 parent a0c5a63
commit 4c723f4
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/packages/next/src/server/config-shared.ts b/packages/next/src/server/config-shared.ts
@@ -544,6 +544,14 @@ export interface NextConfig extends Record<string, any> {
         }
   }
 
+  /**
+   * The type of build output.
+   * - `undefined`: The default build output, `.next` directory, that works with production mode `next start` or a hosting provider like Vercel
+   * - `'standalone'`: A standalone build output, `.next/standalone` directory, that only includes necessary files/dependencies. Useful for self-hosting in a Docker container.
+   * - `'export'`: An exported build output, `out` directory, that only includes static HTML/CSS/JS. Useful for self-hosting without a Node.js server.
+   * @see [Output File Tracing](https://nextjs.org/docs/advanced-features/output-file-tracing)
+   * @see [Static HTML Export](https://nextjs.org/docs/advanced-features/static-html-export)
+   */
   output?: 'standalone' | 'export'
 
   // A list of packages that should always be transpiled and bundled in the server