miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(core): add some docs for maxCacheSize (#30569)

Browse Source 
## Current Behavior
`maxCacheSize` is not documented

## Expected Behavior
`maxCacheSize` is documented

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
This commit is contained in:
Craigory Coppola 2025-04-01 16:35:44 -04:00 committed by GitHub
parent b50727adb4
commit f5d3ba5dcd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/shared/reference/nx-json.md
View File

@ -571,3 +571,31 @@ There are also options for [Nx Cloud](https://nx.app) that are set in the `nx.js
```
For more details on configuring Nx Cloud, see the [Nx Cloud Configuration Options page](/ci/reference/config).
## Max Cache Size
The `maxCacheSize` property in `nx.json` allows you to set a limit on the size of the local cache. If it is not set, Nx defaults to a maximum size of 10% of the size of the disk where the cache is stored, up to a maximum of 10GB. This means that if your disk is 100GB, the maximum cache size will be 10GB. If the cache exceeds the specified size, Nx removes the least recently used cache entries until the total size is below 90% of the specified limit.
This behavior can be opted out by setting `maxCacheSize` to `0`.
Valid values for `maxCacheSize` can be specified in bytes, kilobytes (KB), megabytes (MB), or gigabytes (GB). For example, any of the following would be valid values:
| Value | Description |
| -------- | ---------------------------------------------------------------- |
| `819200` | 819200 bytes (800 KB) |
| `100MB` | 100 megabytes (100 \* 1024 \* 1024 bytes) |
| `1GB` | 1 gigabyte (1024 \* 1024 \* 1024 bytes) |
| `0` | No limit on the local cache size (disables the cache size limit) |
````json {% fileName="nx.json" %}
{
"maxCacheSize": "0" // No limit on the local cache size
}
```json {% fileName="nx.json" %}
{
"maxCacheSize": "10GB" // Set the maximum cache size to 10 gigabytes
}
````
Regardless of the `maxCacheSize` setting, Nx will remove cache entries that have not been accessed in the last 7 days.