11cb0ef41Sopenharmony_ci<!DOCTYPE html> 21cb0ef41Sopenharmony_ci<html lang="en"> 31cb0ef41Sopenharmony_ci<head> 41cb0ef41Sopenharmony_ci <meta charset="utf-8"> 51cb0ef41Sopenharmony_ci <meta name="viewport" content="width=device-width"> 61cb0ef41Sopenharmony_ci <meta name="nodejs.org:node-version" content="v18.20.1"> 71cb0ef41Sopenharmony_ci <title>C++ embedder API | Node.js v18.20.1 Documentation</title> 81cb0ef41Sopenharmony_ci <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> 91cb0ef41Sopenharmony_ci <link rel="stylesheet" href="assets/style.css"> 101cb0ef41Sopenharmony_ci <link rel="stylesheet" href="assets/hljs.css"> 111cb0ef41Sopenharmony_ci <link rel="canonical" href="https://nodejs.org/api/embedding.html"> 121cb0ef41Sopenharmony_ci <script async defer src="assets/api.js" type="text/javascript"></script> 131cb0ef41Sopenharmony_ci 141cb0ef41Sopenharmony_ci</head> 151cb0ef41Sopenharmony_ci<body class="alt apidoc" id="api-section-embedding"> 161cb0ef41Sopenharmony_ci <div id="content" class="clearfix"> 171cb0ef41Sopenharmony_ci <div id="column2" class="interior"> 181cb0ef41Sopenharmony_ci <div id="intro" class="interior"> 191cb0ef41Sopenharmony_ci <a href="/" title="Go back to the home page"> 201cb0ef41Sopenharmony_ci Node.js 211cb0ef41Sopenharmony_ci </a> 221cb0ef41Sopenharmony_ci </div> 231cb0ef41Sopenharmony_ci <ul> 241cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 251cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 261cb0ef41Sopenharmony_ci</ul> 271cb0ef41Sopenharmony_ci<hr class="line"> 281cb0ef41Sopenharmony_ci<ul> 291cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 301cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 311cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 321cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 331cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 341cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 351cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding active">C++ embedder API</a></li> 361cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 371cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 381cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 391cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 401cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 411cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 421cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 431cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 441cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 451cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 461cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 471cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 481cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 491cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 501cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 511cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 521cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 531cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 541cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 551cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 561cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 571cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 581cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 591cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 601cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 611cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 621cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 631cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 641cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 651cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 661cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 671cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 681cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 691cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 701cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 711cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 721cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 731cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 741cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 751cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 761cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 771cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 781cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 791cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 801cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 811cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 821cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 831cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 841cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 851cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 861cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 871cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 881cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 891cb0ef41Sopenharmony_ci</ul> 901cb0ef41Sopenharmony_ci<hr class="line"> 911cb0ef41Sopenharmony_ci<ul> 921cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 931cb0ef41Sopenharmony_ci</ul> 941cb0ef41Sopenharmony_ci </div> 951cb0ef41Sopenharmony_ci 961cb0ef41Sopenharmony_ci <div id="column1" data-id="embedding" class="interior"> 971cb0ef41Sopenharmony_ci <header class="header"> 981cb0ef41Sopenharmony_ci <div class="header-container"> 991cb0ef41Sopenharmony_ci <h1>Node.js v18.20.1 documentation</h1> 1001cb0ef41Sopenharmony_ci <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 1011cb0ef41Sopenharmony_ci <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 1021cb0ef41Sopenharmony_ci <path fill="none" d="M0 0h24v24H0z" /> 1031cb0ef41Sopenharmony_ci <path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/> 1041cb0ef41Sopenharmony_ci <path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/> 1051cb0ef41Sopenharmony_ci </svg> 1061cb0ef41Sopenharmony_ci <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 1071cb0ef41Sopenharmony_ci <path d="M0 0h24v24H0z" fill="none" /> 1081cb0ef41Sopenharmony_ci <path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/> 1091cb0ef41Sopenharmony_ci </svg> 1101cb0ef41Sopenharmony_ci </button> 1111cb0ef41Sopenharmony_ci </div> 1121cb0ef41Sopenharmony_ci <div id="gtoc"> 1131cb0ef41Sopenharmony_ci <ul> 1141cb0ef41Sopenharmony_ci <li class="pinned-header">Node.js v18.20.1</li> 1151cb0ef41Sopenharmony_ci 1161cb0ef41Sopenharmony_ci <li class="picker-header"> 1171cb0ef41Sopenharmony_ci <a href="#"> 1181cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1191cb0ef41Sopenharmony_ci Table of contents 1201cb0ef41Sopenharmony_ci </a> 1211cb0ef41Sopenharmony_ci 1221cb0ef41Sopenharmony_ci <div class="picker"><div class="toc"><ul> 1231cb0ef41Sopenharmony_ci<li><a href="#c-embedder-api">C++ embedder API</a> 1241cb0ef41Sopenharmony_ci<ul> 1251cb0ef41Sopenharmony_ci<li><a href="#example-embedding-application">Example embedding application</a> 1261cb0ef41Sopenharmony_ci<ul> 1271cb0ef41Sopenharmony_ci<li><a href="#setting-up-per-process-state">Setting up per-process state</a></li> 1281cb0ef41Sopenharmony_ci<li><a href="#per-instance-state">Per-instance state</a></li> 1291cb0ef41Sopenharmony_ci</ul> 1301cb0ef41Sopenharmony_ci</li> 1311cb0ef41Sopenharmony_ci</ul> 1321cb0ef41Sopenharmony_ci</li> 1331cb0ef41Sopenharmony_ci</ul></div></div> 1341cb0ef41Sopenharmony_ci </li> 1351cb0ef41Sopenharmony_ci 1361cb0ef41Sopenharmony_ci 1371cb0ef41Sopenharmony_ci <li class="picker-header"> 1381cb0ef41Sopenharmony_ci <a href="#"> 1391cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1401cb0ef41Sopenharmony_ci Index 1411cb0ef41Sopenharmony_ci </a> 1421cb0ef41Sopenharmony_ci 1431cb0ef41Sopenharmony_ci <div class="picker"><ul> 1441cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 1451cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 1461cb0ef41Sopenharmony_ci 1471cb0ef41Sopenharmony_ci <li> 1481cb0ef41Sopenharmony_ci <a href="index.html">Index</a> 1491cb0ef41Sopenharmony_ci </li> 1501cb0ef41Sopenharmony_ci </ul> 1511cb0ef41Sopenharmony_ci 1521cb0ef41Sopenharmony_ci<hr class="line"> 1531cb0ef41Sopenharmony_ci<ul> 1541cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 1551cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 1561cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 1571cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 1581cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 1591cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 1601cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding active">C++ embedder API</a></li> 1611cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 1621cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 1631cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 1641cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 1651cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 1661cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 1671cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 1681cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 1691cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 1701cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 1711cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 1721cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 1731cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 1741cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 1751cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 1761cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 1771cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 1781cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 1791cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 1801cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 1811cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 1821cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 1831cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 1841cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 1851cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 1861cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 1871cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 1881cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 1891cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 1901cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 1911cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 1921cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 1931cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 1941cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 1951cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 1961cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 1971cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 1981cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 1991cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 2001cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 2011cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 2021cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 2031cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 2041cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 2051cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 2061cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 2071cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 2081cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 2091cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 2101cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 2111cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 2121cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 2131cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 2141cb0ef41Sopenharmony_ci</ul> 2151cb0ef41Sopenharmony_ci<hr class="line"> 2161cb0ef41Sopenharmony_ci<ul> 2171cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 2181cb0ef41Sopenharmony_ci</ul></div> 2191cb0ef41Sopenharmony_ci </li> 2201cb0ef41Sopenharmony_ci 2211cb0ef41Sopenharmony_ci 2221cb0ef41Sopenharmony_ci <li class="picker-header"> 2231cb0ef41Sopenharmony_ci <a href="#"> 2241cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2251cb0ef41Sopenharmony_ci Other versions 2261cb0ef41Sopenharmony_ci </a> 2271cb0ef41Sopenharmony_ci <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/embedding.html">21.x</a></li> 2281cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v20.x/api/embedding.html">20.x <b>LTS</b></a></li> 2291cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v19.x/api/embedding.html">19.x</a></li> 2301cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v18.x/api/embedding.html">18.x <b>LTS</b></a></li> 2311cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v17.x/api/embedding.html">17.x</a></li> 2321cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v16.x/api/embedding.html">16.x</a></li> 2331cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v15.x/api/embedding.html">15.x</a></li> 2341cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v14.x/api/embedding.html">14.x</a></li> 2351cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v13.x/api/embedding.html">13.x</a></li> 2361cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v12.x/api/embedding.html">12.x</a></li></ol></div> 2371cb0ef41Sopenharmony_ci </li> 2381cb0ef41Sopenharmony_ci 2391cb0ef41Sopenharmony_ci <li class="picker-header"> 2401cb0ef41Sopenharmony_ci <a href="#"> 2411cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2421cb0ef41Sopenharmony_ci Options 2431cb0ef41Sopenharmony_ci </a> 2441cb0ef41Sopenharmony_ci 2451cb0ef41Sopenharmony_ci <div class="picker"> 2461cb0ef41Sopenharmony_ci <ul> 2471cb0ef41Sopenharmony_ci <li> 2481cb0ef41Sopenharmony_ci <a href="all.html">View on single page</a> 2491cb0ef41Sopenharmony_ci </li> 2501cb0ef41Sopenharmony_ci <li> 2511cb0ef41Sopenharmony_ci <a href="embedding.json">View as JSON</a> 2521cb0ef41Sopenharmony_ci </li> 2531cb0ef41Sopenharmony_ci <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/embedding.md">Edit on GitHub</a></li> 2541cb0ef41Sopenharmony_ci </ul> 2551cb0ef41Sopenharmony_ci </div> 2561cb0ef41Sopenharmony_ci </li> 2571cb0ef41Sopenharmony_ci </ul> 2581cb0ef41Sopenharmony_ci </div> 2591cb0ef41Sopenharmony_ci <hr> 2601cb0ef41Sopenharmony_ci </header> 2611cb0ef41Sopenharmony_ci 2621cb0ef41Sopenharmony_ci <details id="toc" open><summary>Table of contents</summary><ul> 2631cb0ef41Sopenharmony_ci<li><a href="#c-embedder-api">C++ embedder API</a> 2641cb0ef41Sopenharmony_ci<ul> 2651cb0ef41Sopenharmony_ci<li><a href="#example-embedding-application">Example embedding application</a> 2661cb0ef41Sopenharmony_ci<ul> 2671cb0ef41Sopenharmony_ci<li><a href="#setting-up-per-process-state">Setting up per-process state</a></li> 2681cb0ef41Sopenharmony_ci<li><a href="#per-instance-state">Per-instance state</a></li> 2691cb0ef41Sopenharmony_ci</ul> 2701cb0ef41Sopenharmony_ci</li> 2711cb0ef41Sopenharmony_ci</ul> 2721cb0ef41Sopenharmony_ci</li> 2731cb0ef41Sopenharmony_ci</ul></details> 2741cb0ef41Sopenharmony_ci 2751cb0ef41Sopenharmony_ci <div id="apicontent"> 2761cb0ef41Sopenharmony_ci <h2>C++ embedder API<span><a class="mark" href="#c-embedder-api" id="c-embedder-api">#</a></span><a aria-hidden="true" class="legacy" id="embedding_c_embedder_api"></a></h2> 2771cb0ef41Sopenharmony_ci 2781cb0ef41Sopenharmony_ci<p>Node.js provides a number of C++ APIs that can be used to execute JavaScript 2791cb0ef41Sopenharmony_ciin a Node.js environment from other C++ software.</p> 2801cb0ef41Sopenharmony_ci<p>The documentation for these APIs can be found in <a href="https://github.com/nodejs/node/blob/HEAD/src/node.h">src/node.h</a> in the Node.js 2811cb0ef41Sopenharmony_cisource tree. In addition to the APIs exposed by Node.js, some required concepts 2821cb0ef41Sopenharmony_ciare provided by the V8 embedder API.</p> 2831cb0ef41Sopenharmony_ci<p>Because using Node.js as an embedded library is different from writing code 2841cb0ef41Sopenharmony_cithat is executed by Node.js, breaking changes do not follow typical Node.js 2851cb0ef41Sopenharmony_ci<a href="deprecations.html">deprecation policy</a> and may occur on each semver-major release without prior 2861cb0ef41Sopenharmony_ciwarning.</p> 2871cb0ef41Sopenharmony_ci<section><h3>Example embedding application<span><a class="mark" href="#example-embedding-application" id="example-embedding-application">#</a></span><a aria-hidden="true" class="legacy" id="embedding_example_embedding_application"></a></h3> 2881cb0ef41Sopenharmony_ci<p>The following sections will provide an overview over how to use these APIs 2891cb0ef41Sopenharmony_cito create an application from scratch that will perform the equivalent of 2901cb0ef41Sopenharmony_ci<code>node -e <code></code>, i.e. that will take a piece of JavaScript and run it in 2911cb0ef41Sopenharmony_cia Node.js-specific environment.</p> 2921cb0ef41Sopenharmony_ci<p>The full code can be found <a href="https://github.com/nodejs/node/blob/HEAD/test/embedding/embedtest.cc">in the Node.js source tree</a>.</p> 2931cb0ef41Sopenharmony_ci<h4>Setting up per-process state<span><a class="mark" href="#setting-up-per-process-state" id="setting-up-per-process-state">#</a></span><a aria-hidden="true" class="legacy" id="embedding_setting_up_per_process_state"></a></h4> 2941cb0ef41Sopenharmony_ci<p>Node.js requires some per-process state management in order to run:</p> 2951cb0ef41Sopenharmony_ci<ul> 2961cb0ef41Sopenharmony_ci<li>Arguments parsing for Node.js <a href="cli.html">CLI options</a>,</li> 2971cb0ef41Sopenharmony_ci<li>V8 per-process requirements, such as a <code>v8::Platform</code> instance.</li> 2981cb0ef41Sopenharmony_ci</ul> 2991cb0ef41Sopenharmony_ci<p>The following example shows how these can be set up. Some class names are from 3001cb0ef41Sopenharmony_cithe <code>node</code> and <code>v8</code> C++ namespaces, respectively.</p> 3011cb0ef41Sopenharmony_ci<pre><code class="language-cpp"><span class="hljs-function"><span class="hljs-type">int</span> <span class="hljs-title">main</span><span class="hljs-params">(<span class="hljs-type">int</span> argc, <span class="hljs-type">char</span>** argv)</span> </span>{ 3021cb0ef41Sopenharmony_ci argv = <span class="hljs-built_in">uv_setup_args</span>(argc, argv); 3031cb0ef41Sopenharmony_ci <span class="hljs-function">std::vector<std::string> <span class="hljs-title">args</span><span class="hljs-params">(argv, argv + argc)</span></span>; 3041cb0ef41Sopenharmony_ci <span class="hljs-comment">// Parse Node.js CLI options, and print any errors that have occurred while</span> 3051cb0ef41Sopenharmony_ci <span class="hljs-comment">// trying to parse them.</span> 3061cb0ef41Sopenharmony_ci std::unique_ptr<node::InitializationResult> result = 3071cb0ef41Sopenharmony_ci node::<span class="hljs-built_in">InitializeOncePerProcess</span>(args, { 3081cb0ef41Sopenharmony_ci node::ProcessInitializationFlags::kNoInitializeV8, 3091cb0ef41Sopenharmony_ci node::ProcessInitializationFlags::kNoInitializeNodeV8Platform 3101cb0ef41Sopenharmony_ci }); 3111cb0ef41Sopenharmony_ci 3121cb0ef41Sopenharmony_ci <span class="hljs-keyword">for</span> (<span class="hljs-type">const</span> std::string& error : result-><span class="hljs-built_in">errors</span>()) 3131cb0ef41Sopenharmony_ci <span class="hljs-built_in">fprintf</span>(stderr, <span class="hljs-string">"%s: %s\n"</span>, args[<span class="hljs-number">0</span>].<span class="hljs-built_in">c_str</span>(), error.<span class="hljs-built_in">c_str</span>()); 3141cb0ef41Sopenharmony_ci <span class="hljs-keyword">if</span> (result-><span class="hljs-built_in">early_return</span>() != <span class="hljs-number">0</span>) { 3151cb0ef41Sopenharmony_ci <span class="hljs-keyword">return</span> result-><span class="hljs-built_in">exit_code</span>(); 3161cb0ef41Sopenharmony_ci } 3171cb0ef41Sopenharmony_ci 3181cb0ef41Sopenharmony_ci <span class="hljs-comment">// Create a v8::Platform instance. `MultiIsolatePlatform::Create()` is a way</span> 3191cb0ef41Sopenharmony_ci <span class="hljs-comment">// to create a v8::Platform instance that Node.js can use when creating</span> 3201cb0ef41Sopenharmony_ci <span class="hljs-comment">// Worker threads. When no `MultiIsolatePlatform` instance is present,</span> 3211cb0ef41Sopenharmony_ci <span class="hljs-comment">// Worker threads are disabled.</span> 3221cb0ef41Sopenharmony_ci std::unique_ptr<MultiIsolatePlatform> platform = 3231cb0ef41Sopenharmony_ci MultiIsolatePlatform::<span class="hljs-built_in">Create</span>(<span class="hljs-number">4</span>); 3241cb0ef41Sopenharmony_ci V8::<span class="hljs-built_in">InitializePlatform</span>(platform.<span class="hljs-built_in">get</span>()); 3251cb0ef41Sopenharmony_ci V8::<span class="hljs-built_in">Initialize</span>(); 3261cb0ef41Sopenharmony_ci 3271cb0ef41Sopenharmony_ci <span class="hljs-comment">// See below for the contents of this function.</span> 3281cb0ef41Sopenharmony_ci <span class="hljs-type">int</span> ret = <span class="hljs-built_in">RunNodeInstance</span>( 3291cb0ef41Sopenharmony_ci platform.<span class="hljs-built_in">get</span>(), result-><span class="hljs-built_in">args</span>(), result-><span class="hljs-built_in">exec_args</span>()); 3301cb0ef41Sopenharmony_ci 3311cb0ef41Sopenharmony_ci V8::<span class="hljs-built_in">Dispose</span>(); 3321cb0ef41Sopenharmony_ci V8::<span class="hljs-built_in">DisposePlatform</span>(); 3331cb0ef41Sopenharmony_ci 3341cb0ef41Sopenharmony_ci node::<span class="hljs-built_in">TearDownOncePerProcess</span>(); 3351cb0ef41Sopenharmony_ci <span class="hljs-keyword">return</span> ret; 3361cb0ef41Sopenharmony_ci}</code> <button class="copy-button">copy</button></pre> 3371cb0ef41Sopenharmony_ci<h4>Per-instance state<span><a class="mark" href="#per-instance-state" id="per-instance-state">#</a></span><a aria-hidden="true" class="legacy" id="embedding_per_instance_state"></a></h4> 3381cb0ef41Sopenharmony_ci<div class="api_metadata"> 3391cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 3401cb0ef41Sopenharmony_ci<table> 3411cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 3421cb0ef41Sopenharmony_ci<tr><td>v15.0.0</td> 3431cb0ef41Sopenharmony_ci<td><p>The <code>CommonEnvironmentSetup</code> and <code>SpinEventLoop</code> utilities were added.</p></td></tr> 3441cb0ef41Sopenharmony_ci</tbody></table> 3451cb0ef41Sopenharmony_ci</details> 3461cb0ef41Sopenharmony_ci</div> 3471cb0ef41Sopenharmony_ci<p>Node.js has a concept of a “Node.js instance”, that is commonly being referred 3481cb0ef41Sopenharmony_cito as <code>node::Environment</code>. Each <code>node::Environment</code> is associated with:</p> 3491cb0ef41Sopenharmony_ci<ul> 3501cb0ef41Sopenharmony_ci<li>Exactly one <code>v8::Isolate</code>, i.e. one JS Engine instance,</li> 3511cb0ef41Sopenharmony_ci<li>Exactly one <code>uv_loop_t</code>, i.e. one event loop, and</li> 3521cb0ef41Sopenharmony_ci<li>A number of <code>v8::Context</code>s, but exactly one main <code>v8::Context</code>.</li> 3531cb0ef41Sopenharmony_ci<li>One <code>node::IsolateData</code> instance that contains information that could be 3541cb0ef41Sopenharmony_cishared by multiple <code>node::Environment</code>s that use the same <code>v8::Isolate</code>. 3551cb0ef41Sopenharmony_ciCurrently, no testing if performed for this scenario.</li> 3561cb0ef41Sopenharmony_ci</ul> 3571cb0ef41Sopenharmony_ci<p>In order to set up a <code>v8::Isolate</code>, an <code>v8::ArrayBuffer::Allocator</code> needs 3581cb0ef41Sopenharmony_cito be provided. One possible choice is the default Node.js allocator, which 3591cb0ef41Sopenharmony_cican be created through <code>node::ArrayBufferAllocator::Create()</code>. Using the Node.js 3601cb0ef41Sopenharmony_ciallocator allows minor performance optimizations when addons use the Node.js 3611cb0ef41Sopenharmony_ciC++ <code>Buffer</code> API, and is required in order to track <code>ArrayBuffer</code> memory in 3621cb0ef41Sopenharmony_ci<a href="process.html#processmemoryusage"><code>process.memoryUsage()</code></a>.</p> 3631cb0ef41Sopenharmony_ci<p>Additionally, each <code>v8::Isolate</code> that is used for a Node.js instance needs to 3641cb0ef41Sopenharmony_cibe registered and unregistered with the <code>MultiIsolatePlatform</code> instance, if one 3651cb0ef41Sopenharmony_ciis being used, in order for the platform to know which event loop to use 3661cb0ef41Sopenharmony_cifor tasks scheduled by the <code>v8::Isolate</code>.</p> 3671cb0ef41Sopenharmony_ci<p>The <code>node::NewIsolate()</code> helper function creates a <code>v8::Isolate</code>, 3681cb0ef41Sopenharmony_cisets it up with some Node.js-specific hooks (e.g. the Node.js error handler), 3691cb0ef41Sopenharmony_ciand registers it with the platform automatically.</p> 3701cb0ef41Sopenharmony_ci<pre><code class="language-cpp"><span class="hljs-function"><span class="hljs-type">int</span> <span class="hljs-title">RunNodeInstance</span><span class="hljs-params">(MultiIsolatePlatform* platform, 3711cb0ef41Sopenharmony_ci <span class="hljs-type">const</span> std::vector<std::string>& args, 3721cb0ef41Sopenharmony_ci <span class="hljs-type">const</span> std::vector<std::string>& exec_args)</span> </span>{ 3731cb0ef41Sopenharmony_ci <span class="hljs-type">int</span> exit_code = <span class="hljs-number">0</span>; 3741cb0ef41Sopenharmony_ci 3751cb0ef41Sopenharmony_ci <span class="hljs-comment">// Setup up a libuv event loop, v8::Isolate, and Node.js Environment.</span> 3761cb0ef41Sopenharmony_ci std::vector<std::string> errors; 3771cb0ef41Sopenharmony_ci std::unique_ptr<CommonEnvironmentSetup> setup = 3781cb0ef41Sopenharmony_ci CommonEnvironmentSetup::<span class="hljs-built_in">Create</span>(platform, &errors, args, exec_args); 3791cb0ef41Sopenharmony_ci <span class="hljs-keyword">if</span> (!setup) { 3801cb0ef41Sopenharmony_ci <span class="hljs-keyword">for</span> (<span class="hljs-type">const</span> std::string& err : errors) 3811cb0ef41Sopenharmony_ci <span class="hljs-built_in">fprintf</span>(stderr, <span class="hljs-string">"%s: %s\n"</span>, args[<span class="hljs-number">0</span>].<span class="hljs-built_in">c_str</span>(), err.<span class="hljs-built_in">c_str</span>()); 3821cb0ef41Sopenharmony_ci <span class="hljs-keyword">return</span> <span class="hljs-number">1</span>; 3831cb0ef41Sopenharmony_ci } 3841cb0ef41Sopenharmony_ci 3851cb0ef41Sopenharmony_ci Isolate* isolate = setup-><span class="hljs-built_in">isolate</span>(); 3861cb0ef41Sopenharmony_ci Environment* env = setup-><span class="hljs-built_in">env</span>(); 3871cb0ef41Sopenharmony_ci 3881cb0ef41Sopenharmony_ci { 3891cb0ef41Sopenharmony_ci <span class="hljs-function">Locker <span class="hljs-title">locker</span><span class="hljs-params">(isolate)</span></span>; 3901cb0ef41Sopenharmony_ci <span class="hljs-function">Isolate::Scope <span class="hljs-title">isolate_scope</span><span class="hljs-params">(isolate)</span></span>; 3911cb0ef41Sopenharmony_ci <span class="hljs-function">HandleScope <span class="hljs-title">handle_scope</span><span class="hljs-params">(isolate)</span></span>; 3921cb0ef41Sopenharmony_ci <span class="hljs-comment">// The v8::Context needs to be entered when node::CreateEnvironment() and</span> 3931cb0ef41Sopenharmony_ci <span class="hljs-comment">// node::LoadEnvironment() are being called.</span> 3941cb0ef41Sopenharmony_ci <span class="hljs-function">Context::Scope <span class="hljs-title">context_scope</span><span class="hljs-params">(setup->context())</span></span>; 3951cb0ef41Sopenharmony_ci 3961cb0ef41Sopenharmony_ci <span class="hljs-comment">// Set up the Node.js instance for execution, and run code inside of it.</span> 3971cb0ef41Sopenharmony_ci <span class="hljs-comment">// There is also a variant that takes a callback and provides it with</span> 3981cb0ef41Sopenharmony_ci <span class="hljs-comment">// the `require` and `process` objects, so that it can manually compile</span> 3991cb0ef41Sopenharmony_ci <span class="hljs-comment">// and run scripts as needed.</span> 4001cb0ef41Sopenharmony_ci <span class="hljs-comment">// The `require` function inside this script does *not* access the file</span> 4011cb0ef41Sopenharmony_ci <span class="hljs-comment">// system, and can only load built-in Node.js modules.</span> 4021cb0ef41Sopenharmony_ci <span class="hljs-comment">// `module.createRequire()` is being used to create one that is able to</span> 4031cb0ef41Sopenharmony_ci <span class="hljs-comment">// load files from the disk, and uses the standard CommonJS file loader</span> 4041cb0ef41Sopenharmony_ci <span class="hljs-comment">// instead of the internal-only `require` function.</span> 4051cb0ef41Sopenharmony_ci MaybeLocal<Value> loadenv_ret = node::<span class="hljs-built_in">LoadEnvironment</span>( 4061cb0ef41Sopenharmony_ci env, 4071cb0ef41Sopenharmony_ci <span class="hljs-string">"const publicRequire ="</span> 4081cb0ef41Sopenharmony_ci <span class="hljs-string">" require('node:module').createRequire(process.cwd() + '/');"</span> 4091cb0ef41Sopenharmony_ci <span class="hljs-string">"globalThis.require = publicRequire;"</span> 4101cb0ef41Sopenharmony_ci <span class="hljs-string">"require('node:vm').runInThisContext(process.argv[1]);"</span>); 4111cb0ef41Sopenharmony_ci 4121cb0ef41Sopenharmony_ci <span class="hljs-keyword">if</span> (loadenv_ret.<span class="hljs-built_in">IsEmpty</span>()) <span class="hljs-comment">// There has been a JS exception.</span> 4131cb0ef41Sopenharmony_ci <span class="hljs-keyword">return</span> <span class="hljs-number">1</span>; 4141cb0ef41Sopenharmony_ci 4151cb0ef41Sopenharmony_ci exit_code = node::<span class="hljs-built_in">SpinEventLoop</span>(env).<span class="hljs-built_in">FromMaybe</span>(<span class="hljs-number">1</span>); 4161cb0ef41Sopenharmony_ci 4171cb0ef41Sopenharmony_ci <span class="hljs-comment">// node::Stop() can be used to explicitly stop the event loop and keep</span> 4181cb0ef41Sopenharmony_ci <span class="hljs-comment">// further JavaScript from running. It can be called from any thread,</span> 4191cb0ef41Sopenharmony_ci <span class="hljs-comment">// and will act like worker.terminate() if called from another thread.</span> 4201cb0ef41Sopenharmony_ci node::<span class="hljs-built_in">Stop</span>(env); 4211cb0ef41Sopenharmony_ci } 4221cb0ef41Sopenharmony_ci 4231cb0ef41Sopenharmony_ci <span class="hljs-keyword">return</span> exit_code; 4241cb0ef41Sopenharmony_ci}</code> <button class="copy-button">copy</button></pre></section> 4251cb0ef41Sopenharmony_ci <!-- API END --> 4261cb0ef41Sopenharmony_ci </div> 4271cb0ef41Sopenharmony_ci </div> 4281cb0ef41Sopenharmony_ci </div> 4291cb0ef41Sopenharmony_ci</body> 4301cb0ef41Sopenharmony_ci</html> 431