Next.js-config con verificación de tipos

Cómo utilizar la verificación de tipos para su next.config.js

Comprobación de tipo simple para next.config.js

Este no es tanto un artículo real sino más bien una reedición de una parte de la documentación de Next.js, ya que creo que es importante que se comparta. Con respecto al uso de tipos para next.config.js, no hay ningún soporte oficial real por parte del equipo de Next.js ya que el uso de un archivo Typecript para esta configuración no es posible sin algunos trucos.

Desde la versión 10.2.3, el siguiente fragmento de código está disponible en la documentación para habilitar una variante simple de verificación de tipos. Tenga en cuenta que estamos usando TypeScript, pero el archivo de configuración no será transpilado por el paquete del proyecto. La característica que se está utilizando es la etiqueta "@type" de JSDoc para importar tipos en un archivo JS.

// Add the following line at the top of the file:
// @ts-check

// Then for the config itself, import the types
// via '@type'-tag.

 /**
  * @type {import('next/dist/next-server/server/config').NextConfig}
  **/
 const nextConfig = {
   /* config options here */
 }

// End of file.
module.exports = nextConfig

Por supuesto, también puede configurar una configuración de Typecript personalizada y un paso de preprocesador para transpilar la configuración a Javascript por su cuenta. Pero por ahora, creo que no vale la pena el esfuerzo, ya que los proveedores de complementos no cuentan con un soporte sustancial para Typescript. Entonces, después de todo, terminará con tipos para su configuración base, pero aún necesitaría "cualquiera" para todos los demás complementos sin tipos.

Sugerencias

Relacionados

Adenda

Idiomas