next

property abstract

abstract?: null | string | undefined;

• A brief description of the web page.

  Remarks

  Rendered as the abstract meta tag. This is *not recommended* as it is superseded by description.

  Example 1

  abstract: "My Website Description"
  // Renders <meta name="abstract" content="My Website Description" />

property alternates

alternates?: null | AlternateURLs | undefined;

• The canonical and alternate URLs for the document.

  Remarks

  This field allows defining a canonical URL as well as alternate URLs (such as for multiple languages).

  Example 1

  alternates: {
    canonical: "https://example.com",
    languages: {
      "en-US": "https://example.com/en-US"
    }
  }

property appleWebApp

appleWebApp?: null | boolean | AppleWebApp | undefined;

• The Apple web app metadata for the document.

  Example 1

  appleWebApp: { capable: true, title: "My Website", statusBarStyle: "black-translucent" }

  See Also

  • https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariHTMLRef/Articles/MetaTags.html

property applicationName

applicationName?: null | string | undefined;

• The application name.

  Example 1

  applicationName: "My Blog"
  // Renders: <meta name="application-name" content="My Blog" />

property appLinks

appLinks?: null | AppLinks | undefined;

• The Facebook AppLinks metadata for the document.

  Example 1

  appLinks: {
    ios: { appStoreId: "123456789", url: "https://example.com" },
    android: { packageName: "com.example", url: "https://example.com" }
  }
  
  // Renders
  <meta property="al:ios:app_store_id" content="123456789" />
  <meta property="al:ios:url" content="https://example.com" />
  <meta property="al:android:package" content="com.example" />
  <meta property="al:android:url" content="https://example.com" />

property archives

archives?: null | string | Array<string> | undefined;

• The archives link rel property.

  Example 1

  archives: "https://example.com/archives"
  // Renders <link rel="archives" href="https://example.com/archives" />

property assets

assets?: null | string | Array<string> | undefined;

• The assets link rel property.

  Example 1

  assets: "https://example.com/assets"
  // Renders <link rel="assets" href="https://example.com/assets" />

property authors

authors?: null | Author | Array<Author> | undefined;

• The authors of the document.

  Example 1

  authors: [{ name: "Next.js Team", url: "https://nextjs.org" }]
  // Renders:
  // <meta name="author" content="Next.js Team" />
  // <link rel="author" href="https://nextjs.org" />

property bookmarks

bookmarks?: null | string | Array<string> | undefined;

• The bookmarks link rel property.

  Remarks

  Although technically against the HTML spec, this is used in practice.

  Example 1

  bookmarks: "https://example.com/bookmarks"
  // Renders <link rel="bookmarks" href="https://example.com/bookmarks" />

property category

category?: null | string | undefined;

• The category meta name property.

  Example 1

  category: "My Category"
  // Renders <meta name="category" content="My Category" />

property classification

classification?: null | string | undefined;

• The classification meta name property.

  Example 1

  classification: "My Classification"
  // Renders <meta name="classification" content="My Classification" />

property colorScheme

colorScheme?: null | ColorSchemeEnum | undefined;

• The color scheme for the document.

  Deprecated

  Use the new viewport configuration (export const viewport: Viewport = { ... }) instead.

property creator

creator?: null | string | undefined;

• The creator of the document.

  Example 1

  creator: "Next.js Team"
  // Renders: <meta name="creator" content="Next.js Team" />

property description

description?: null | string | undefined;

• The document description, and optionally the Open Graph and Twitter descriptions.

  Example 1

  description: "My Blog Description"
  // Renders: <meta name="description" content="My Blog Description" />

property facebook

facebook?: null | Facebook | undefined;

• The Facebook metadata for the document.

  Remarks

  Specify either appId or admins (but not both) to configure Facebook integration.

  Example 1

  facebook: { appId: "12345678" }
  // Renders <meta property="fb:app_id" content="12345678" />
  // or
  facebook: { admins: ["12345678"] }
  // Renders <meta property="fb:admins" content="12345678" />

property formatDetection

formatDetection?: null | FormatDetection | undefined;

• Indicates whether devices should interpret certain formats (such as telephone numbers) as actionable links.

  Example 1

  formatDetection: { telephone: false }
  // Renders: <meta name="format-detection" content="telephone=no" />

property generator

generator?: null | string | undefined;

• The generator used for the document.

  Example 1

  generator: "Next.js"
  // Renders: <meta name="generator" content="Next.js" />

property icons

icons?: null | IconURL | Array<Icon> | Icons | undefined;

• The icons for the document. Defaults to rel="icon".

  Remarks

  You can specify a simple URL or an object to differentiate between icon types (e.g., apple-touch-icon).

  Example 1

  icons: "https://example.com/icon.png"
  // or
  icons: {
    icon: "https://example.com/icon.png",
    apple: "https://example.com/apple-icon.png"
  }

  See Also

  • https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-icon

property itunes

itunes?: null | ItunesApp | undefined;

• The metadata for the iTunes App.

  Remarks

  Adds the name="apple-itunes-app" meta tag.

  Example 1

  itunes: { app: { id: "123456789", affiliateData: "123456789", appArguments: "123456789" } }
  // Renders <meta name="apple-itunes-app" content="app-id=123456789, affiliate-data=123456789, app-arguments=123456789" />

property keywords

keywords?: null | string | Array<string> | undefined;

• The keywords for the document.

  Remarks

  When an array is provided, keywords are flattened into a comma-separated string.

  Example 1

  keywords: "nextjs, react, blog"
  // or
  keywords: ["react", "server components"]

property manifest

manifest?: null | string | URL | undefined;

• A web application manifest, as defined in the Web Application Manifest specification.

  Example 1

  manifest: "https://example.com/manifest.json"
  // Renders: <link rel="manifest" href="https://example.com/manifest.json" />

  See Also

  • https://developer.mozilla.org/docs/Web/Manifest

property metadataBase

metadataBase?: null | URL | undefined;

• The base path and origin for absolute URLs in various metadata fields.

  Remarks

  When relative URLs (for Open Graph images, alternates, etc.) are used, they are composed with this base. If not provided, Next.js will populate a default value based on environment variables.

property openGraph

openGraph?: null | OpenGraph | undefined;

• The Open Graph metadata for the document.

  Remarks

  Follows the Open Graph protocol to enrich link previews.

  Example 1

  openGraph: {
    type: "website",
    url: "https://example.com",
    title: "My Website",
    description: "My Website Description",
    siteName: "My Website",
    images: [{ url: "https://example.com/og.png" }]
  }

  See Also

  • https://ogp.me/

property other

other?:
    | ({
          [name: string]: string | number | Array<string | number>;
      } & DeprecatedMetadataFields)
    | undefined;

• Arbitrary name/value pairs for additional metadata.

  Remarks

  Use this field to define custom meta tags that are not directly supported.

  Example 1

  other: { custom: ["meta1", "meta2"] }

property pagination

pagination?: {
    previous?: null | string | URL | undefined;
    next?: null | string | URL | undefined;
};

• The pagination link rel properties.

  Example 1

  pagination: {
    previous: "https://example.com/items?page=1",
    next: "https://example.com/items?page=3"
  }
  
  // Renders
  <link rel="prev" href="https://example.com/items?page=1" />
  <link rel="next" href="https://example.com/items?page=3" />

  See Also

  • https://developers.google.com/search/blog/2011/09/pagination-with-relnext-and-relprev

property pinterest

pinterest?: null | Pinterest;

• The Pinterest metadata for the document to choose whether opt out of rich pin data.

  Example 1

  pinterest: { richPin: true }
  // Renders <meta name="pinterest-rich-pin" content="true" />

property publisher

publisher?: null | string | undefined;

• The publisher of the document.

  Example 1

  publisher: "Vercel"
  // Renders: <meta name="publisher" content="Vercel" />

property referrer

referrer?: null | ReferrerEnum | undefined;

• The referrer setting for the document.

  Example 1

  referrer: "origin"
  // Renders: <meta name="referrer" content="origin" />

property robots

robots?: null | string | Robots | undefined;

• The robots setting for the document.

  Remarks

  Can be a string (e.g., "index, follow") or an object with more granular rules.

  Example 1

  robots: "index, follow"
  // or
  robots: { index: true, follow: true }

  See Also

  • https://developer.mozilla.org/docs/Glossary/Robots.txt

property themeColor

themeColor?:
    | null
    | string
    | ThemeColorDescriptor
    | ThemeColorDescriptor[]
    | undefined;

• The theme color for the document.

  Deprecated

  Use the new viewport configuration (export const viewport: Viewport = { ... }) instead.

property title

title?: null | string | TemplateString | undefined;

• The document title.

  Remarks

  The title can be a simple string (e.g., "My Blog") or an object with: - default: A fallback title for child segments. - template: A title template (e.g., "%s | My Website") applied to child titles. - absolute: A title that overrides parent templates.

  Example 1

  // As a simple string:
  title: "My Blog"
  
  // As a template object:
  title: { default: "Dashboard", template: "%s | My Website" }
  
  // Using absolute value (ignores parent template):
  title: { absolute: "My Blog", template: "%s | My Website" }

property twitter

twitter?: null | Twitter | undefined;

• The Twitter metadata for the document.

  Remarks

  - Used for configuring Twitter Cards and can include details such as card, site, and creator. - Notably, more sites than just Twitter (now X) use this format.

  Example 1

  twitter: {
    card: "summary_large_image",
    site: "@site",
    creator: "@creator",
    images: "https://example.com/og.png"
  }

property verification

verification?: Verification | undefined;

• The common verification tokens for the document.

  Example 1

  verification: { google: "1234567890", yandex: "1234567890", "me": "1234567890" }
  // Renders <meta name="google-site-verification" content="1234567890" />
  // <meta name="yandex-verification" content="1234567890" />
  // <meta name="me" content="@me" />

property viewport

viewport?: null | string | ViewportLayout | undefined;

• The viewport setting for the document.

  Deprecated

  Use the new viewport configuration (export const viewport: Viewport = { ... }) instead.

property modifyConfig

modifyConfig?: (
    config: NextConfigComplete
) => Promise<NextConfigComplete> | NextConfigComplete;

property name

name: string;

property onBuildComplete

onBuildComplete?: (ctx: {
    routes: {
        headers: Array<ManifestHeaderRoute>;
        redirects: Array<ManifestRedirectRoute>;
        rewrites: {
            beforeFiles: Array<ManifestRewriteRoute>;
            afterFiles: Array<ManifestRewriteRoute>;
            fallback: Array<ManifestRewriteRoute>;
        };
        dynamicRoutes: ReadonlyArray<ManifestRoute>;
    };
    outputs: AdapterOutputs;
}) => Promise<void> | void;

property body

body: any;

property cookies

cookies: Partial<{
    [key: string]: string;
}>;

• Object of cookies from header

property draftMode

draftMode?: boolean;

property env

env: Env;

property preview

preview?: boolean;

property previewData

previewData?: PreviewData;

• Preview data set on the request, if any

property query

query: Partial<{
    [key: string]: string | string[];
}>;

• Object of query values from url

property allowedDevOrigins

allowedDevOrigins?: string[];

property amp

amp?: {
    canonicalBase?: string;
};

• See Also

  • [next/amp](https://nextjs.org/docs/api-reference/next/amp)

  Deprecated

  built-in amp support will be removed in Next 16

property assetPrefix

assetPrefix?: string;

• To set up a CDN, you can set up an asset prefix and configure your CDN's origin to resolve to the domain that Next.js is hosted on.

  See Also

  • [CDN Support with Asset Prefix](https://nextjs.org/docs/app/api-reference/config/next-config-js/assetPrefix)

property basePath

basePath?: string;

• Deploy a Next.js application under a sub-path of a domain

  See Also

  • [Base path configuration](https://nextjs.org/docs/app/api-reference/config/next-config-js/basePath)

property bundlePagesRouterDependencies

bundlePagesRouterDependencies?: boolean;

• Enables the bundling of node_modules packages (externals) for pages server-side bundles.

  See Also

  • https://nextjs.org/docs/pages/api-reference/next-config-js/bundlePagesRouterDependencies

property cacheHandler

cacheHandler?: string | undefined;

• The default cache handler for the Pages and App Router uses the filesystem cache. This requires no configuration, however, you can customize the cache handler if you prefer.

  See Also

  • [Configuring Caching](https://nextjs.org/docs/app/building-your-application/deploying#configuring-caching) and the [API Reference](https://nextjs.org/docs/app/api-reference/next-config-js/incrementalCacheHandlerPath).

property cacheMaxMemorySize

cacheMaxMemorySize?: number;

• Configure the in-memory cache size in bytes. Defaults to 50 MB. If cacheMaxMemorySize: 0, this disables in-memory caching entirely.

  See Also

  • [Configuring Caching](https://nextjs.org/docs/app/building-your-application/deploying#configuring-caching).

property cleanDistDir

cleanDistDir?: boolean;

• The build output directory (defaults to .next) is now cleared by default except for the Next.js caches.

property compiler

compiler?: {
    reactRemoveProperties?:
        | boolean
        | {
              properties?: string[];
          };
    relay?: {
        src: string;
        artifactDirectory?: string;
        language?: 'typescript' | 'javascript' | 'flow';
        eagerEsModules?: boolean;
    };
    removeConsole?:
        | boolean
        | {
              exclude?: string[];
          };
    styledComponents?: boolean | StyledComponentsConfig;
    emotion?: boolean | EmotionConfig;
    styledJsx?:
        | boolean
        | {
              useLightningcss?: boolean;
          };
    /**
     * Replaces variables in your code during compile time. Each key will be
     * replaced with the respective values.
     */
    define?: Record<string, string>;
    /**
     * Replaces server-only (Node.js and Edge) variables in your code during compile time.
     * Each key will be replaced with the respective values.
     */
    defineServer?: Record<string, string>;
    /**
     * A hook function that executes after production build compilation finishes,
     * but before running post-compilation tasks such as type checking and
     * static page generation.
     */
    runAfterProductionCompile?: (metadata: {
        /**
         * The root directory of the project
         */
        projectDir: string;
        /**
         * The build output directory (defaults to `.next`)
         */
        distDir: string;
    }) => Promise<void>;
};

• Optionally enable compiler transforms

  See Also

  • [Supported Compiler Options](https://nextjs.org/docs/advanced-features/compiler#supported-features)

property compress

compress?: boolean;

• See Also

  • [Compression documentation](https://nextjs.org/docs/app/api-reference/config/next-config-js/compress)

property crossOrigin

crossOrigin?: 'anonymous' | 'use-credentials';

• Add "crossorigin" attribute to generated <script> elements generated by <Head /> or <NextScript /> components

  See Also

  • [crossorigin attribute documentation](https://developer.mozilla.org/docs/Web/HTML/Attributes/crossorigin)

property deploymentId

deploymentId?: string;

• A unique identifier for a deployment that will be included in each request's query string or header.

property devIndicators

devIndicators?:
    | false
    | {
          /**
           * @deprecated The dev tools indicator has it enabled by default. To disable, set `devIndicators` to `false`.
           * */
          appIsrStatus?: boolean;
          /**
           * Show "building..." indicator in development
           * @deprecated The dev tools indicator has it enabled by default. To disable, set `devIndicators` to `false`.
           */
          buildActivity?: boolean;
          /**
           * Position of "building..." indicator in browser
           * @default "bottom-right"
           * @deprecated Renamed as `position`.
           */
          buildActivityPosition?:
              | 'top-left'
              | 'top-right'
              | 'bottom-left'
              | 'bottom-right';
          /**
           * Position of the development tools indicator in the browser window.
           * @default "bottom-left"
           * */
          position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
      };

• Configure indicators in development environment

property distDir

distDir?: string;

• Destination directory (defaults to .next)

property env

env?: Record<string, string | undefined>;

• Next.js comes with built-in support for environment variables

  See Also

  • [Environment Variables documentation](https://nextjs.org/docs/app/api-reference/config/next-config-js/env)

property eslint

eslint?: ESLintConfig;

• version 11

  See Also

  • [ESLint configuration](https://nextjs.org/docs/app/api-reference/config/eslint)

property excludeDefaultMomentLocales

excludeDefaultMomentLocales?: boolean;

• See Also

  • [Moment.js locales excluded by default](https://nextjs.org/docs/upgrading#momentjs-locales-excluded-by-default)

property experimental

experimental?: ExperimentalConfig;

• Enable experimental features. Note that all experimental features are subject to breaking changes in the future.

property expireTime

expireTime?: number;

• period (in seconds) where the server allow to serve stale cache

property exportPathMap

exportPathMap?: (
    defaultMap: ExportPathMap,
    ctx: {
        dev: boolean;
        dir: string;
        outDir: string | null;
        distDir: string;
        buildId: string;
    }
) => Promise<ExportPathMap> | ExportPathMap;

property generateBuildId

generateBuildId?: () => string | null | Promise<string | null>;

• See Also

  • [Configuring the build ID](https://nextjs.org/docs/app/api-reference/config/next-config-js/generateBuildId)

property generateEtags

generateEtags?: boolean;

• See Also

  • [Disabling ETag Configuration](https://nextjs.org/docs/app/api-reference/config/next-config-js/generateEtags)

property headers

headers?: () => Promise<Header[]>;

• Headers allow you to set custom HTTP headers for an incoming request path.

  See Also

  • [Headers configuration documentation](https://nextjs.org/docs/app/api-reference/config/next-config-js/headers)

property htmlLimitedBots

htmlLimitedBots?: RegExp;

• User Agent of bots that can handle streaming metadata. Besides the default behavior, Next.js act differently on serving metadata to bots based on their capability.

  /Mediapartners-Google|Slurp|DuckDuckBot|baiduspider|yandex|sogou|bitlybot|tumblr|vkShare|quora link preview|redditbot|ia_archiver|Bingbot|BingPreview|applebot|facebookexternalhit|facebookcatalog|Twitterbot|LinkedInBot|Slackbot|Discordbot|WhatsApp|SkypeUriPreview/i

property httpAgentOptions

httpAgentOptions?: {
    keepAlive?: boolean;
};

• Next.js enables HTTP Keep-Alive by default. You may want to disable HTTP Keep-Alive for certain fetch() calls or globally.

  See Also

  • [Disabling HTTP Keep-Alive](https://nextjs.org/docs/app/api-reference/next-config-js/httpAgentOptions)

property i18n

i18n?: I18NConfig | null;

• Internationalization configuration

  See Also

  • [Internationalization docs](https://nextjs.org/docs/advanced-features/i18n-routing)

property images

images?: ImageConfig;

• See Also

  • [Using the Image Component](https://nextjs.org/docs/app/api-reference/next-config-js/images)

property logging

logging?: LoggingConfig | false;

• Logging configuration. Set to false to disable logging.

property modularizeImports

modularizeImports?: Record<
    string,
    {
        transform: string | Record<string, string>;
        preventFullImport?: boolean;
        skipDefaultConversion?: boolean;
    }
>;

property onDemandEntries

onDemandEntries?: {
    /** period (in ms) where the server will keep pages in the buffer */
    maxInactiveAge?: number;
    /** number of pages that should be kept simultaneously without being disposed */
    pagesBufferLength?: number;
};

• Next.js exposes some options that give you some control over how the server will dispose or keep in memory built pages in development.

  See Also

  • [Configuring onDemandEntries](https://nextjs.org/docs/app/api-reference/config/next-config-js/onDemandEntries)

property output

output?: 'standalone' | 'export';

• 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 Also

  • [Output File Tracing](https://nextjs.org/docs/advanced-features/output-file-tracing)

  • [Static HTML Export](https://nextjs.org/docs/advanced-features/static-html-export)

property outputFileTracingExcludes

outputFileTracingExcludes?: Record<string, string[]>;

• This allows manually excluding traced files if too many are included incorrectly on a per-page basis.

property outputFileTracingIncludes

outputFileTracingIncludes?: Record<string, string[]>;

• This allows manually including traced files if some were not detected on a per-page basis.

property outputFileTracingRoot

outputFileTracingRoot?: string;

• This is the repo root usually and only files above this directory are traced and included.

property pageExtensions

pageExtensions?: string[];

• See Also

  • [Including non-page files in the pages directory](https://nextjs.org/docs/app/api-reference/config/next-config-js/pageExtensions)

property poweredByHeader

poweredByHeader?: boolean;

• See Also

  • [Disabling x-powered-by](https://nextjs.org/docs/app/api-reference/config/next-config-js/poweredByHeader)

property productionBrowserSourceMaps

productionBrowserSourceMaps?: boolean;

• Enable browser source map generation during the production build

  See Also

  • [Source Maps](https://nextjs.org/docs/advanced-features/source-maps)

property publicRuntimeConfig

publicRuntimeConfig?: {
    [key: string]: any;
};

• Add public (in browser) runtime configuration to your app

  See Also

  • [Runtime configuration](https://nextjs.org/docs/pages/api-reference/config/next-config-js/runtime-configuration

property reactMaxHeadersLength

reactMaxHeadersLength?: number;

• The maximum length of the headers that are emitted by React and added to the response.

  See Also

  • [React Max Headers Length](https://nextjs.org/docs/app/api-reference/config/next-config-js/reactMaxHeadersLength)

property reactProductionProfiling

reactProductionProfiling?: boolean;

• Enable react profiling in production

property reactStrictMode

reactStrictMode?: boolean | null;

• The Next.js runtime is Strict Mode-compliant.

  See Also

  • [React Strict Mode](https://nextjs.org/docs/app/api-reference/config/next-config-js/reactStrictMode)

property redirects

redirects?: () => Promise<Redirect[]>;

• Redirects allow you to redirect an incoming request path to a different destination path.

  See Also

  • [Redirects configuration documentation](https://nextjs.org/docs/app/api-reference/config/next-config-js/redirects)

property rewrites

rewrites?: () => Promise<
    | Rewrite[]
    | {
          beforeFiles?: Rewrite[];
          afterFiles?: Rewrite[];
          fallback?: Rewrite[];
      }
>;

• Rewrites allow you to map an incoming request path to a different destination path.

  See Also

  • [Rewrites configuration documentation](https://nextjs.org/docs/app/api-reference/config/next-config-js/rewrites)

property sassOptions

sassOptions?: {
    implementation?: string;
    [key: string]: any;
};

• See Also

  • [Customizing sass options](https://nextjs.org/docs/app/api-reference/next-config-js/sassOptions)

property serverExternalPackages

serverExternalPackages?: string[];

• A list of packages that should be treated as external in the server build.

  See Also

  • https://nextjs.org/docs/app/api-reference/next-config-js/serverExternalPackages

property serverRuntimeConfig

serverRuntimeConfig?: {
    [key: string]: any;
};

• Add server runtime configuration to your app

  See Also

  • [Runtime configuration](https://nextjs.org/docs/pages/api-reference/config/next-config-js/runtime-configuration

property skipMiddlewareUrlNormalize

skipMiddlewareUrlNormalize?: boolean;

property skipTrailingSlashRedirect

skipTrailingSlashRedirect?: boolean;

property staticPageGenerationTimeout

staticPageGenerationTimeout?: number;

• Timeout after waiting to generate static pages in seconds

  60

property trailingSlash

trailingSlash?: boolean;

• By default Next.js will redirect urls with trailing slashes to their counterpart without a trailing slash.

  false

  See Also

  • [Trailing Slash Configuration](https://nextjs.org/docs/app/api-reference/config/next-config-js/trailingSlash)

property transpilePackages

transpilePackages?: string[];

• Automatically transpile and bundle dependencies from local packages (like monorepos) or from external dependencies (node_modules). This replaces the next-transpile-modules package.

  See Also

  • [transpilePackages](https://nextjs.org/docs/advanced-features/compiler#module-transpilation)

property turbopack

turbopack?: TurbopackOptions;

• Options for Turbopack. Temporarily also available as experimental.turbo for compatibility.

property typedRoutes

typedRoutes?: boolean;

• Enable type checking for Link and Router.push, etc. This feature requires TypeScript in your project.

  See Also

  • [Typed Links documentation](https://nextjs.org/docs/app/api-reference/config/typescript#statically-typed-links)

property typescript

typescript?: TypeScriptConfig;

• See Also

  • [Next.js TypeScript documentation](https://nextjs.org/docs/app/api-reference/config/typescript)

property useFileSystemPublicRoutes

useFileSystemPublicRoutes?: boolean;

• By default, Next will serve each file in the pages folder under a pathname matching the filename. To disable this behavior and prevent routing based set this to true.

  true

  See Also

  • [Disabling file-system routing](https://nextjs.org/docs/advanced-features/custom-server#disabling-file-system-routing)

property watchOptions

watchOptions?: {
    pollIntervalMs?: number;
};

property webpack

webpack?: NextJsWebpackConfig | null;

• Before continuing to add custom webpack configuration to your application make sure Next.js doesn't already support your use-case

  See Also

  • [Custom Webpack Config documentation](https://nextjs.org/docs/app/api-reference/config/next-config-js/webpack)

property AppTree

AppTree: AppTreeType;

• Component the tree of the App to use if needing to render separately

property asPath

asPath?: string;

• String of the actual path including query.

property defaultLocale

defaultLocale?: string;

• The configured default locale

property err

err?:
    | (Error & {
          statusCode?: number;
      })
    | null;

• Error object if encountered during rendering

property locale

locale?: string;

• The currently active locale

property locales

locales?: readonly string[];

• All configured locales

property pathname

pathname: string;

• Path section of URL.

property query

query: ParsedUrlQuery;

• Query string section of URL parsed as an object.

property req

req?: IncomingMessage;

• HTTP request object.

property res

res?: ServerResponse;

• HTTP response object.

property abstract

abstract: null | string;

property alternates

alternates: null | ResolvedAlternateURLs;

property appleWebApp

appleWebApp: null | ResolvedAppleWebApp;

property applicationName

applicationName: null | string;

property appLinks

appLinks: null | ResolvedAppLinks;

property archives

archives: null | Array<string>;

property assets

assets: null | Array<string>;

property authors

authors: null | Array<Author>;

property bookmarks

bookmarks: null | Array<string>;

property category

category: null | string;

property classification

classification: null | string;

property colorScheme

colorScheme: null | ColorSchemeEnum;

• Deprecated

property creator

creator: null | string;

property description

description: null | string;

property facebook

facebook: null | ResolvedFacebook;

property formatDetection

formatDetection: null | FormatDetection;

property generator

generator: null | string;

property icons

icons: null | ResolvedIcons;

property itunes

itunes: null | ItunesApp;

property keywords

keywords: null | Array<string>;

property manifest

manifest: null | string | URL;

property metadataBase

metadataBase: null | URL;

property openGraph

openGraph: null | ResolvedOpenGraph;

property other

other:
    | null
    | ({
          [name: string]: string | number | Array<string | number>;
      } & DeprecatedMetadataFields);

property pagination

pagination: {
    previous: null | string;
    next: null | string;
};

property pinterest

pinterest: null | ResolvedPinterest;

property publisher

publisher: null | string;

property referrer

referrer: null | ReferrerEnum;

property robots

robots: null | ResolvedRobots;

property themeColor

themeColor: null | ThemeColorDescriptor[];

• Deprecated

property title

title: null | AbsoluteTemplateString;

property twitter

twitter: null | ResolvedTwitterMetadata;

property verification

verification: null | ResolvedVerification;

property viewport

viewport: null | string;

• Deprecated

property colorScheme

colorScheme: null | ColorSchemeEnum;

property themeColor

themeColor: null | ThemeColorDescriptor[];

property colorScheme

colorScheme?: null | ColorSchemeEnum | undefined;

• The color scheme for the document.

  Example 1

  colorScheme: "dark"
  // Renders <meta name="color-scheme" content="dark" />

property themeColor

themeColor?:
    | null
    | string
    | ThemeColorDescriptor
    | ThemeColorDescriptor[]
    | undefined;

• The theme color for the document.

  Example 1

  themeColor: "#000000"
  // Renders <meta name="theme-color" content="#000000" />
  
  themeColor: { media: "(prefers-color-scheme: dark)", color: "#000000" }
  // Renders <meta name="theme-color" media="(prefers-color-scheme: dark)" content="#000000" />
  
  themeColor: [
   { media: "(prefers-color-scheme: dark)", color: "#000000" },
   { media: "(prefers-color-scheme: light)", color: "#ffffff" }
  ]
  // Renders <meta name="theme-color" media="(prefers-color-scheme: dark)" content="#000000" />
  // Renders <meta name="theme-color" media="(prefers-color-scheme: light)" content="#ffffff" />