Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 68fbc0c

Browse filesBrowse files
joyeecheungaduh95
joyeecheung
authored and
aduh95
committed
module: mark module compile cache as stable
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: #60971 Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
1 parent 3e7010d commit 68fbc0c
Copy full SHA for 68fbc0c

2 files changed

+24-10Lines changed: 24 additions & 10 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎doc/api/cli.md‎

Copy file name to clipboardExpand all lines: doc/api/cli.md
+4-2Lines changed: 4 additions & 2 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -3307,10 +3307,12 @@ Any other value will result in colorized output being disabled.
33073307

33083308
<!-- YAML
33093309
added: v22.1.0
3310+
changes:
3311+
- version: REPLACEME
3312+
pr-url: https://github.com/nodejs/node/pull/60971
3313+
description: This feature is no longer experimental.
33103314
-->
33113315

3312-
> Stability: 1.1 - Active Development
3313-
33143316
Enable the [module compile cache][] for the Node.js instance. See the documentation of
33153317
[module compile cache][] for details.
33163318

Collapse file

‎doc/api/module.md‎

Copy file name to clipboardExpand all lines: doc/api/module.md
+20-8Lines changed: 20 additions & 8 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,11 @@ to disk when the Node.js instance is about to exit. This is subject to change. T
415415
is flushed to disk in case the application wants to spawn other Node.js instances
416416
and let them share the cache long before the parent exits.
417417
418+
The compile cache layout on disk is an implementation detail and should not be
419+
relied upon. The compile cache generated is typically only reusable in the same
420+
version of Node.js, and should be not assumed to be compatible across different
421+
versions of Node.js.
422+
418423
### Portability of the compile cache
419424
420425
By default, caches are invalidated when the absolute paths of the modules being
@@ -454,10 +459,12 @@ separately if the same base directory is used to persist the cache, so they can
454459
455460
<!-- YAML
456461
added: v22.8.0
462+
changes:
463+
- version: REPLACEME
464+
pr-url: https://github.com/nodejs/node/pull/60971
465+
description: This feature is no longer experimental.
457466
-->
458467
459-
> Stability: 1.1 - Active Development
460-
461468
The following constants are returned as the `status` field in the object returned by
462469
[`module.enableCompileCache()`][] to indicate the result of the attempt to enable the
463470
[module compile cache][].
@@ -508,6 +515,9 @@ The following constants are returned as the `status` field in the object returne
508515
<!-- YAML
509516
added: v22.8.0
510517
changes:
518+
- version: REPLACEME
519+
pr-url: https://github.com/nodejs/node/pull/60971
520+
description: This feature is no longer experimental.
511521
- version: v24.12.0
512522
pr-url: https://github.com/nodejs/node/pull/58797
513523
description: Add `portable` option to enable portable compile cache.
@@ -516,8 +526,6 @@ changes:
516526
description: Rename the unreleased `path` option to `directory` to maintain consistency.
517527
-->
518528
519-
> Stability: 1.1 - Active Development
520-
521529
* `options` {string|Object} Optional. If a string is passed, it is considered to be `options.directory`.
522530
* `directory` {string} Optional. Directory to store the compile cache. If not specified,
523531
the directory specified by the [`NODE_COMPILE_CACHE=dir`][] environment variable
@@ -562,10 +570,12 @@ be inherited into the child workers. The directory can be obtained either from t
562570
added:
563571
- v23.0.0
564572
- v22.10.0
573+
changes:
574+
- version: REPLACEME
575+
pr-url: https://github.com/nodejs/node/pull/60971
576+
description: This feature is no longer experimental.
565577
-->
566578
567-
> Stability: 1.1 - Active Development
568-
569579
Flush the [module compile cache][] accumulated from modules already loaded
570580
in the current Node.js instance to disk. This returns after all the flushing
571581
file system operations come to an end, no matter they succeed or not. If there
@@ -576,10 +586,12 @@ interfere with the actual operation of the application.
576586
577587
<!-- YAML
578588
added: v22.8.0
589+
changes:
590+
- version: REPLACEME
591+
pr-url: https://github.com/nodejs/node/pull/60971
592+
description: This feature is no longer experimental.
579593
-->
580594
581-
> Stability: 1.1 - Active Development
582-
583595
* Returns: {string|undefined} Path to the [module compile cache][] directory if it is enabled,
584596
or `undefined` otherwise.
585597

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.