turbopackGcExperimental
The experimental.turbopackGc option controls garbage collection for Turbopack's in-memory and persistent caches. Garbage collection is enabled by default. To disable it, set the option to false:
next.config.ts
import type { NextConfig } from 'next'
const nextConfig: NextConfig = {
experimental: {
turbopackGc: false,
},
}
export default nextConfignext.config.js
/** @type {import('next').NextConfig} */
const nextConfig = {
experimental: {
turbopackGc: false,
},
}
module.exports = nextConfigReference
turbopackGc defaults to true and accepts a boolean or an object:
| Value | Description |
|---|---|
false | Disables garbage collection. |
true | Enables garbage collection with the default timings. |
{ minProgressMs?, rootTtlMs? } | Enables garbage collection and overrides one or more of the default timings. |
When enabled, Turbopack removes unreachable work from memory and its persistent cache. The option applies to both next dev and next build when they use Turbopack.
Good to know:
- Garbage collection requires the Turbopack FileSystem Cache. The option has no effect when the cache is disabled for the current command.
- In long-running read-write sessions, Turbopack disables garbage collection when
turbopackMemoryEvictionis set tofalse.
Options
The object form accepts the following properties:
| Property | Type | Default | Description |
|---|---|---|---|
minProgressMs | Non-negative number | 100 | Minimum time a garbage collection pass runs before it honors an interruption. |
rootTtlMs | Non-negative number | 259200000 (3 days) | Time a garbage collection root can remain unanchored before Turbopack removes it. |
The following configuration lets a garbage collection pass run for at least 200 milliseconds before yielding and expires unanchored roots after one day:
next.config.ts
import type { NextConfig } from 'next'
const nextConfig: NextConfig = {
experimental: {
turbopackGc: {
minProgressMs: 200,
rootTtlMs: 24 * 60 * 60 * 1000,
},
},
}
export default nextConfignext.config.js
/** @type {import('next').NextConfig} */
const nextConfig = {
experimental: {
turbopackGc: {
minProgressMs: 200,
rootTtlMs: 24 * 60 * 60 * 1000,
},
},
}
module.exports = nextConfigVersion History
| Version | Changes |
|---|---|
v16.5.0 | experimental.turbopackGc is enabled by default. |
v16.4.0 | experimental.turbopackGc configuration option added. |