doc: correct cluster serialization default - #65186
Closed
arhxam wants to merge 1 commit into
Closed
Conversation
The serialization option accepts json or advanced, but its documented default was boolean false. Cluster delegates to child_process.fork(), whose effective default is json. Correct the value so the type and behavior agree. Signed-off-by: Arham Wani <arhamwani765@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The
cluster.settings.serializationdocumentation describes the option as astring accepting
'json'or'advanced', but lists its default as the booleanfalse.Cluster passes this option to
child_process.fork(). When it is omitted,lib/internal/child_process.jsselects'json'; the correspondingchild_process.fork()documentation also records'json'as the default.This corrects the cluster documentation to use the effective string default.
Documentation-only change.