withFaust
The withFaust
helper function is used to merge your next.config.js
config with necessary Faust.js configuration.
Usage
To use withFaust
, create a next.config.js
file in your project root with the following content:
next.config.js
const { withFaust } = require('@faustjs/next');
/**
* @type {import('next').NextConfig}
**/
module.exports = withFaust();
Code language: JavaScript (javascript)
If you already have a next.config.js
file, you can use the first argument of withFaust
to merge in your existing config.
Take the following example, where we have a custom next.config.js
handling a rewrite:
next.config.js
const { withFaust } = require('@faustjs/next');
const nextConfig = {
async rewrites() {
return [
{
source: '/about',
destination: '/',
},
];
},
};
/**
* @type {import('next').NextConfig}
**/
module.exports = withFaust(nextConfig);
Code language: JavaScript (javascript)
Additional Options
withFaust
also accepts a second argument for withFaustConfig
. withFaustConfig
represented as a TypeScript interface looks like:
interface WithFaustConfig {
// Where preview links will be redirected to.
previewDestination?: string;
}
Code language: JavaScript (javascript)
For example, if you wanted to change the default preview destination from /preview
to /previews
, you can do so by passing the following to withFaust
:
next.config.js
const { withFaust } = require('@faustjs/next');
const nextConfig = {};
const withFaustConfig = {
previewDestination: '/previews',
};
/**
* @type {import('next').NextConfig}
**/
module.exports = withFaust(nextConfig, withFaustConfig);
Code language: JavaScript (javascript)
NOTE
If you change the previewDestination
path, do not forget to create an associated page
with the same name for that destination. Otherwise the framework will redirect to a non existing page and it will show a 404
response.