Mirrors/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-12-27 23:41:14 +00:00
Code Issues Actions 18 Packages Projects Releases Wiki Activity

module: mark module compile cache as stable

Browse Source 
The feature set has been stable without any breaking changes
in the past year, and it's been depended enough in the wild
by popular packages that we'll likely need to treat any breakages
as semver-major in the future anyway. The future TODOs are likely
all non-breaking. Potential subtle breakages in implementation
details that should not be relied upon (such as the cache layout)
are explicitly excluded from the contract.

We'll investigate whether it can be enabled by default as a
different topic, which can be potentially semver-major.

PR-URL: https://github.com/nodejs/node/pull/60971
Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
This commit is contained in:
Joyee Cheung 2025-12-08 16:08:11 +01:00 committed by GitHub
parent caa0cbf94f
commit 1fbe842d64
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/api/cli.md
View File

@ -3403,10 +3403,12 @@ Any other value will result in colorized output being disabled.
<!-- YAML
added: v22.1.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/60971
description: This feature is no longer experimental.
-->
> Stability: 1.1 - Active Development
Enable the [module compile cache][] for the Node.js instance. See the documentation of
[module compile cache][] for details.

28
doc/api/module.md
View File

@ -410,6 +410,11 @@ to disk when the Node.js instance is about to exit. This is subject to change. T
is flushed to disk in case the application wants to spawn other Node.js instances
and let them share the cache long before the parent exits.
The compile cache layout on disk is an implementation detail and should not be
relied upon. The compile cache generated is typically only reusable in the same
version of Node.js, and should be not assumed to be compatible across different
versions of Node.js.
### Portability of the compile cache
By default, caches are invalidated when the absolute paths of the modules being
@ -449,10 +454,12 @@ separately if the same base directory is used to persist the cache, so they can
<!-- YAML
added: v22.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/60971
description: This feature is no longer experimental.
-->
> Stability: 1.1 - Active Development
The following constants are returned as the `status` field in the object returned by
[`module.enableCompileCache()`][] to indicate the result of the attempt to enable the
[module compile cache][].
@ -503,6 +510,9 @@ The following constants are returned as the `status` field in the object returne
<!-- YAML
added: v22.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/60971
description: This feature is no longer experimental.
- version: v25.0.0
pr-url: https://github.com/nodejs/node/pull/58797
description: Add `portable` option to enable portable compile cache.
@ -511,8 +521,6 @@ changes:
description: Rename the unreleased `path` option to `directory` to maintain consistency.
-->
> Stability: 1.1 - Active Development
* `options` {string|Object} Optional. If a string is passed, it is considered to be `options.directory`.
* `directory` {string} Optional. Directory to store the compile cache. If not specified,
the directory specified by the [`NODE_COMPILE_CACHE=dir`][] environment variable
@ -557,10 +565,12 @@ be inherited into the child workers. The directory can be obtained either from t
added:
- v23.0.0
- v22.10.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/60971
description: This feature is no longer experimental.
-->
> Stability: 1.1 - Active Development
Flush the [module compile cache][] accumulated from modules already loaded
in the current Node.js instance to disk. This returns after all the flushing
file system operations come to an end, no matter they succeed or not. If there
@ -571,10 +581,12 @@ interfere with the actual operation of the application.
<!-- YAML
added: v22.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/60971
description: This feature is no longer experimental.
-->
> Stability: 1.1 - Active Development
* Returns: {string|undefined} Path to the [module compile cache][] directory if it is enabled,
or `undefined` otherwise.