Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add documentation for process.features #54897

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions doc/api/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -1896,6 +1896,103 @@ a code.
Specifying a code to [`process.exit(code)`][`process.exit()`] will override any
previous setting of `process.exitCode`.

## `process.features.cached_builtins`

<!-- YAML
added: REPLACEME
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#27311

Suggested change
added: REPLACEME
added: v12.0.0

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lol

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand, why were all these suggestions resolved but not applied?

Copy link
Member Author

@marco-ippolito marco-ippolito Sep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see I have overwritten the commit with the suggestions with a rebase, probably not updated the remote and force pushed https://github.com/nodejs/node/compare/15d260e6bef2c00f1ca9ef84fa361a551d82976e..e3f91db3ae988513599915ad8f6e73068f2bb0da

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've opened #54982 to fix this.

-->

* {boolean}

A boolean value that is `true` if the current Node.js build is caching builtin modules.

## `process.features.debug`

<!-- YAML
added: REPLACEME
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved
-->

* {boolean}

A boolean value that is `true` if the current Node.js build is a debug build.

## `process.features.inspector`

<!-- YAML
added: REPLACEME
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved
-->

* {boolean}

A boolean value that is `true` if the current Node.js build includes the inspector.

## `process.features.ipv6`

<!-- YAML
added: REPLACEME
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved
-->

* {boolean}

A boolean value that is `true` if the current Node.js build includes support for IPv6.

## `process.features.tls`

<!-- YAML
added: REPLACEME
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved
-->

* {boolean}

A boolean value that is `true` if the current Node.js build includes support for TLS.

## `process.features.tls_alpn`

<!-- YAML
added: REPLACEME
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved
-->

* {boolean}

A boolean value that is `true` if the current Node.js build includes support for ALPN in TLS.

***

## `process.features.tls_ocsp`

<!-- YAML
added: REPLACEME
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved
-->

* {boolean}

A boolean value that is `true` if the current Node.js build includes support for OCSP in TLS.

***

## `process.features.tls_sni`

<!-- YAML
added: REPLACEME
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved
-->

* {boolean}

A boolean value that is `true` if the current Node.js build includes support for SNI in TLS.

***

## `process.features.uv`

<!-- YAML
added: REPLACEME
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved
-->

* {boolean}

A boolean value that is `true` if the current Node.js build includes support for libuv.
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved
Since it's currently not possible to build Node.js without libuv, this value is always `true`.

## `process.finalization.register(ref, callback)`

<!-- YAML
Expand Down
Loading