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.

Sign up for GitHub

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

Jump to bottom

doc,worker: document resourceLimits overrides #43992

Merged
merged 2 commits into from Aug 29, 2022
Merged

doc,worker: document resourceLimits overrides #43992

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44c9fcc
doc,worker: document resourceLimits overrides
kvakil Jul 26, 2022
61fc604
fixup! doc,worker: document resourceLimits overrides
kvakil Jul 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 11 additions & 5 deletions doc/api/worker_threads.md
View file
Open in desktop
Expand Up @@ -987,11 +987,15 @@ changes:
are passed in `workerData`, a `transferList` is required for those
items or [`ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST`][] is thrown.
See [`port.postMessage()`][] for more information.
* `resourceLimits` {Object} An optional set of resource limits for the new
JS engine instance. Reaching these limits leads to termination of the
`Worker` instance. These limits only affect the JS engine, and no external
data, including no `ArrayBuffer`s. Even if these limits are set, the process
may still abort if it encounters a global out-of-memory situation.
* `resourceLimits` {Object} An optional set of resource limits for the new JS
engine instance. Reaching these limits leads to termination of the `Worker`
instance. These limits only affect the JS engine, and no external data,
including no `ArrayBuffer`s. Even if these limits are set, the process may
still abort if it encounters a global out-of-memory situation. These
kvakil marked this conversation as resolved.
Show resolved Hide resolved
limits can be overriden by V8 arguments passed to the main thread. In
kvakil marked this conversation as resolved.
Show resolved Hide resolved
particular, [`--max-old-space-size`][] overrides `maxOldGenerationSizeMb`
and [`--max-semi-space-size`][] overrides `maxYoungGenerationSizeMb` for
all created threads.
* `maxOldGenerationSizeMb` {number} The maximum size of the main heap in MB.
* `maxYoungGenerationSizeMb` {number} The maximum size of a heap space for
recently created objects.
Expand Down Expand Up @@ -1332,6 +1336,8 @@ thread spawned will spawn another until the application crashes.
[`'close'` event]: #event-close
[`'exit'` event]: #event-exit
[`'online'` event]: #event-online
[`--max-old-space-size`]: cli.md#--max-old-space-sizesize-in-megabytes
[`--max-semi-space-size`]: cli.md#--max-semi-space-sizesize-in-megabytes
[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
[`AsyncResource`]: async_hooks.md#class-asyncresource
[`Buffer.allocUnsafe()`]: buffer.md#static-method-bufferallocunsafesize
Expand Down