Sitelet https://github.com/nodejs/node/pull/48193/commits/55706b4e2baec11bdff5a1a10946d79605936277
Skip to content

doc,vm: clarify usage of cachedData in vm.compileFunction() #48193

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

Merged
nodejs-github-bot merged 1 commit into from
May 29, 2023
Merged

doc,vm: clarify usage of cachedData in vm.compileFunction() #48193

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
doc,vm: clarify usage of cachedData in vm.compileFunction() 
Fixes: #48175
Signed-off-by: Darshan Sen <raisinten@gmail.com>
  • Loading branch information
@RaisinTen
RaisinTen committed May 26, 2023
commit 55706b4e2baec11bdff5a1a10946d79605936277
4 changes: 3 additions & 1 deletion doc/api/vm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1005,7 +1005,8 @@ changes:
is displayed in stack traces produced by this script. **Default:** `0`.
* `cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or
`TypedArray`, or `DataView` with V8's code cache data for the supplied
source.
source. This must be produced by a prior call to [`vm.compileFunction()`][]
with the same `code` and `params`.
* `produceCachedData` {boolean} Specifies whether to produce new cache data.
**Default:** `false`.
* `parsingContext` {Object} The [contextified][] object in which the said
Expand Down Expand Up @@ -1593,6 +1594,7 @@ are not controllable through the timeout either.
[`script.runInContext()`]: #scriptrunincontextcontextifiedobject-options
[`script.runInThisContext()`]: #scriptruninthiscontextoptions
[`url.origin`]: url.md#urlorigin
[`vm.compileFunction()`]: #vmcompilefunctioncode-params-options
[`vm.createContext()`]: #vmcreatecontextcontextobject-options
[`vm.runInContext()`]: #vmrunincontextcode-contextifiedobject-options
[`vm.runInThisContext()`]: #vmruninthiscontextcode-options
Expand Down