Add JSDoc for all non-experimental configurations

vercel · Feb 5, 2022 · 95ca863 · 95ca863
1 parent 1128252
commit 95ca863
Showing 1 changed file with 7 additions and 7 deletions.
diff --git a/packages/next/server/config-shared.ts b/packages/next/server/config-shared.ts
@@ -51,7 +51,7 @@ export interface TypeScriptConfig {
 export interface WebpackConfigContext {
   /** Next.js root directory */
   dir: string
-  /** It's `true` for `next dev` compilation and `false` for `next build` compilation */
+  /** Indicates if the compilation will be done in development */
   dev: boolean
   /** It's `true` for server-side compilation, and `false` for client-side compilation */
   isServer: boolean
@@ -131,7 +131,7 @@ export interface ExperimentalConfig {
 
 /**
  * Next configuration object
- * @see [configuration documentations](https://nextjs.org/docs/api-reference/next.config.js/introduction)
+ * @see [configuration documentation](https://nextjs.org/docs/api-reference/next.config.js/introduction)
  */
 export interface NextConfig extends Record<string, any> {
   /**
@@ -155,14 +155,14 @@ export interface NextConfig extends Record<string, any> {
   /**
    * Headers allow you to set custom HTTP headers for an incoming request path.
    *
-   * @see [Headers configuration documentations](https://nextjs.org/docs/api-reference/next.config.js/headers)
+   * @see [Headers configuration documentation](https://nextjs.org/docs/api-reference/next.config.js/headers)
    */
   headers?: () => Promise<Header[]>
 
   /**
    * Rewrites allow you to map an incoming request path to a different destination path.
    *
-   * @see [Rewrites configuration documentations](https://nextjs.org/docs/api-reference/next.config.js/rewrites)
+   * @see [Rewrites configuration documentation](https://nextjs.org/docs/api-reference/next.config.js/rewrites)
    */
   rewrites?: () => Promise<
     | Rewrite[]
@@ -176,7 +176,7 @@ export interface NextConfig extends Record<string, any> {
   /**
    * Redirects allow you to redirect an incoming request path to a different destination path.
    *
-   * @see [Redirects configuration documentations](https://nextjs.org/docs/api-reference/next.config.js/redirects)
+   * @see [Redirects configuration documentation](https://nextjs.org/docs/api-reference/next.config.js/redirects)
    */
   redirects?: () => Promise<Redirect[]>
 
@@ -247,7 +247,7 @@ export interface NextConfig extends Record<string, any> {
   /** @see [Including non-page files in the pages directory](https://nextjs.org/docs/api-reference/next.config.js/custom-page-extensions#including-non-page-files-in-the-pages-directory) */
   pageExtensions?: string[]
 
-  /** @see [Compression documentations](https://nextjs.org/docs/api-reference/next.config.js/compression) */
+  /** @see [Compression documentation](https://nextjs.org/docs/api-reference/next.config.js/compression) */
   compress?: boolean
 
   /** @see [Disabling x-powered-by](https://nextjs.org/docs/api-reference/next.config.js/disabling-x-powered-by) */
@@ -366,7 +366,7 @@ export interface NextConfig extends Record<string, any> {
    * Add `"crossorigin"` attribute to generated `<script>` elements generated by `<Head />` or `<NextScript />` components
    *
    *
-   * @see [`crossorigin` attribute documentations](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin)
+   * @see [`crossorigin` attribute documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin)
    */
   crossOrigin?: false | 'anonymous' | 'use-credentials'