• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html>
2<html lang="en">
3<head>
4  <meta charset="utf-8">
5  <meta name="viewport" content="width=device-width">
6  <meta name="nodejs.org:node-version" content="v14.19.1">
7  <title>Inspector | Node.js v14.19.1 Documentation</title>
8  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback">
9  <link rel="stylesheet" href="assets/style.css">
10  <link rel="stylesheet" href="assets/hljs.css">
11  <link rel="canonical" href="https://nodejs.org/api/inspector.html">
12</head>
13<body class="alt apidoc" id="api-section-inspector">
14  <div id="content" class="clearfix">
15    <div id="column2" class="interior">
16      <div id="intro" class="interior">
17        <a href="/" title="Go back to the home page">
18          Node.js
19        </a>
20      </div>
21      <ul>
22<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li>
23<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li>
24</ul>
25<hr class="line">
26<ul>
27<li><a href="assert.html" class="nav-assert">Assertion testing</a></li>
28<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li>
29<li><a href="buffer.html" class="nav-buffer">Buffer</a></li>
30<li><a href="addons.html" class="nav-addons">C++ addons</a></li>
31<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li>
32<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li>
33<li><a href="child_process.html" class="nav-child_process">Child processes</a></li>
34<li><a href="cluster.html" class="nav-cluster">Cluster</a></li>
35<li><a href="cli.html" class="nav-cli">Command-line options</a></li>
36<li><a href="console.html" class="nav-console">Console</a></li>
37<li><a href="corepack.html" class="nav-corepack">Corepack</a></li>
38<li><a href="crypto.html" class="nav-crypto">Crypto</a></li>
39<li><a href="debugger.html" class="nav-debugger">Debugger</a></li>
40<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li>
41<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li>
42<li><a href="dns.html" class="nav-dns">DNS</a></li>
43<li><a href="domain.html" class="nav-domain">Domain</a></li>
44<li><a href="errors.html" class="nav-errors">Errors</a></li>
45<li><a href="events.html" class="nav-events">Events</a></li>
46<li><a href="fs.html" class="nav-fs">File system</a></li>
47<li><a href="globals.html" class="nav-globals">Globals</a></li>
48<li><a href="http.html" class="nav-http">HTTP</a></li>
49<li><a href="http2.html" class="nav-http2">HTTP/2</a></li>
50<li><a href="https.html" class="nav-https">HTTPS</a></li>
51<li><a href="inspector.html" class="nav-inspector active">Inspector</a></li>
52<li><a href="intl.html" class="nav-intl">Internationalization</a></li>
53<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li>
54<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li>
55<li><a href="module.html" class="nav-module">Modules: <code>module</code> API</a></li>
56<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li>
57<li><a href="net.html" class="nav-net">Net</a></li>
58<li><a href="os.html" class="nav-os">OS</a></li>
59<li><a href="path.html" class="nav-path">Path</a></li>
60<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li>
61<li><a href="policy.html" class="nav-policy">Policies</a></li>
62<li><a href="process.html" class="nav-process">Process</a></li>
63<li><a href="punycode.html" class="nav-punycode">Punycode</a></li>
64<li><a href="querystring.html" class="nav-querystring">Query strings</a></li>
65<li><a href="readline.html" class="nav-readline">Readline</a></li>
66<li><a href="repl.html" class="nav-repl">REPL</a></li>
67<li><a href="report.html" class="nav-report">Report</a></li>
68<li><a href="stream.html" class="nav-stream">Stream</a></li>
69<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li>
70<li><a href="timers.html" class="nav-timers">Timers</a></li>
71<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li>
72<li><a href="tracing.html" class="nav-tracing">Trace events</a></li>
73<li><a href="tty.html" class="nav-tty">TTY</a></li>
74<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li>
75<li><a href="url.html" class="nav-url">URL</a></li>
76<li><a href="util.html" class="nav-util">Utilities</a></li>
77<li><a href="v8.html" class="nav-v8">V8</a></li>
78<li><a href="vm.html" class="nav-vm">VM</a></li>
79<li><a href="wasi.html" class="nav-wasi">WASI</a></li>
80<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li>
81<li><a href="zlib.html" class="nav-zlib">Zlib</a></li>
82</ul>
83<hr class="line">
84<ul>
85<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li>
86</ul>
87    </div>
88
89    <div id="column1" data-id="inspector" class="interior">
90      <header>
91        <div class="header-container">
92          <h1>Node.js v14.19.1 documentation</h1>
93          <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden>
94            <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24">
95              <path fill="none" d="M0 0h24v24H0z" />
96              <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"/>
97              <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"/>
98            </svg>
99            <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24">
100              <path d="M0 0h24v24H0z" fill="none" />
101              <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"/>
102            </svg>
103          </button>
104        </div>
105        <div id="gtoc">
106          <ul>
107            <li>
108              <a href="index.html">Index</a>
109            </li>
110            <li>
111              <a href="all.html">View on single page</a>
112            </li>
113            <li>
114              <a href="inspector.json">View as JSON</a>
115            </li>
116
117    <li class="version-picker">
118      <a href="#">View another version <span>&#x25bc;</span></a>
119      <ol class="version-picker"><li><a href="https://nodejs.org/docs/latest-v17.x/api/inspector.html">17.x</a></li>
120<li><a href="https://nodejs.org/docs/latest-v16.x/api/inspector.html">16.x <b>LTS</b></a></li>
121<li><a href="https://nodejs.org/docs/latest-v15.x/api/inspector.html">15.x</a></li>
122<li><a href="https://nodejs.org/docs/latest-v14.x/api/inspector.html">14.x <b>LTS</b></a></li>
123<li><a href="https://nodejs.org/docs/latest-v13.x/api/inspector.html">13.x</a></li>
124<li><a href="https://nodejs.org/docs/latest-v12.x/api/inspector.html">12.x <b>LTS</b></a></li>
125<li><a href="https://nodejs.org/docs/latest-v11.x/api/inspector.html">11.x</a></li>
126<li><a href="https://nodejs.org/docs/latest-v10.x/api/inspector.html">10.x</a></li>
127<li><a href="https://nodejs.org/docs/latest-v9.x/api/inspector.html">9.x</a></li>
128<li><a href="https://nodejs.org/docs/latest-v8.x/api/inspector.html">8.x</a></li></ol>
129    </li>
130
131            <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/master/doc/api/inspector.md">Edit on GitHub</a></li>
132          </ul>
133        </div>
134        <hr>
135      </header>
136
137      <details id="toc" open><summary>Table of contents</summary><ul>
138<li><span class="stability_2"><a href="#inspector_inspector">Inspector</a></span>
139<ul>
140<li><a href="#inspector_inspector_close"><code>inspector.close()</code></a></li>
141<li><a href="#inspector_inspector_console"><code>inspector.console</code></a></li>
142<li><a href="#inspector_inspector_open_port_host_wait"><code>inspector.open([port[, host[, wait]]])</code></a></li>
143<li><a href="#inspector_inspector_url"><code>inspector.url()</code></a></li>
144<li><a href="#inspector_inspector_waitfordebugger"><code>inspector.waitForDebugger()</code></a></li>
145<li><a href="#inspector_class_inspector_session">Class: <code>inspector.Session</code></a>
146<ul>
147<li><a href="#inspector_new_inspector_session"><code>new inspector.Session()</code></a></li>
148<li><a href="#inspector_event_inspectornotification">Event: <code>'inspectorNotification'</code></a></li>
149<li><a href="#inspector_event_inspector_protocol_method">Event: <code>&#x3C;inspector-protocol-method></code>;</a></li>
150<li><a href="#inspector_session_connect"><code>session.connect()</code></a></li>
151<li><a href="#inspector_session_connecttomainthread"><code>session.connectToMainThread()</code></a></li>
152<li><a href="#inspector_session_disconnect"><code>session.disconnect()</code></a></li>
153<li><a href="#inspector_session_post_method_params_callback"><code>session.post(method[, params][, callback])</code></a></li>
154</ul>
155</li>
156<li><a href="#inspector_example_usage">Example usage</a>
157<ul>
158<li><a href="#inspector_cpu_profiler">CPU profiler</a></li>
159<li><a href="#inspector_heap_profiler">Heap profiler</a></li>
160</ul>
161</li>
162</ul>
163</li>
164</ul></details>
165
166      <div id="apicontent">
167        <h2>Inspector<span><a class="mark" href="#inspector_inspector" id="inspector_inspector">#</a></span></h2>
168
169<p></p><div class="api_stability api_stability_2"><a href="documentation.html#documentation_stability_index">Stability: 2</a> - Stable</div><p></p>
170<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v14.19.1/lib/inspector.js">lib/inspector.js</a></p>
171<p>The <code>inspector</code> module provides an API for interacting with the V8 inspector.</p>
172<p>It can be accessed using:</p>
173<pre><code class="language-js"><span class="hljs-keyword">const</span> inspector = <span class="hljs-built_in">require</span>(<span class="hljs-string">'inspector'</span>);</code></pre>
174<section><h3><code>inspector.close()</code><span><a class="mark" href="#inspector_inspector_close" id="inspector_inspector_close">#</a></span></h3>
175<p>Deactivate the inspector. Blocks until there are no active connections.</p>
176</section><section><h3><code>inspector.console</code><span><a class="mark" href="#inspector_inspector_console" id="inspector_inspector_console">#</a></span></h3>
177<ul>
178<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type">&#x3C;Object></a> An object to send messages to the remote inspector console.</li>
179</ul>
180<pre><code class="language-js"><span class="hljs-built_in">require</span>(<span class="hljs-string">'inspector'</span>).<span class="hljs-property">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'a message'</span>);</code></pre>
181<p>The inspector console does not have API parity with Node.js
182console.</p>
183</section><section><h3><code>inspector.open([port[, host[, wait]]])</code><span><a class="mark" href="#inspector_inspector_open_port_host_wait" id="inspector_inspector_open_port_host_wait">#</a></span></h3>
184<ul>
185<li><code>port</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type">&#x3C;number></a> Port to listen on for inspector connections. Optional.
186<strong>Default:</strong> what was specified on the CLI.</li>
187<li><code>host</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string></a> Host to listen on for inspector connections. Optional.
188<strong>Default:</strong> what was specified on the CLI.</li>
189<li><code>wait</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type">&#x3C;boolean></a> Block until a client has connected. Optional.
190<strong>Default:</strong> <code>false</code>.</li>
191</ul>
192<p>Activate inspector on host and port. Equivalent to <code>node --inspect=[[host:]port]</code>, but can be done programmatically after node has
193started.</p>
194<p>If wait is <code>true</code>, will block until a client has connected to the inspect port
195and flow control has been passed to the debugger client.</p>
196<p>See the <a href="cli.html#inspector_security">security warning</a> regarding the <code>host</code>
197parameter usage.</p>
198</section><section><h3><code>inspector.url()</code><span><a class="mark" href="#inspector_inspector_url" id="inspector_inspector_url">#</a></span></h3>
199<ul>
200<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Undefined_type" class="type">&#x3C;undefined></a></li>
201</ul>
202<p>Return the URL of the active inspector, or <code>undefined</code> if there is none.</p>
203<pre><code class="language-console"><span class="hljs-meta">$ </span><span class="language-bash">node --inspect -p <span class="hljs-string">'inspector.url()'</span></span>
204Debugger listening on ws://127.0.0.1:9229/166e272e-7a30-4d09-97ce-f1c012b43c34
205For help see https://nodejs.org/en/docs/inspector
206ws://127.0.0.1:9229/166e272e-7a30-4d09-97ce-f1c012b43c34
207<span class="hljs-meta">
208$ </span><span class="language-bash">node --inspect=localhost:3000 -p <span class="hljs-string">'inspector.url()'</span></span>
209Debugger listening on ws://localhost:3000/51cf8d0e-3c36-4c59-8efd-54519839e56a
210For help see https://nodejs.org/en/docs/inspector
211ws://localhost:3000/51cf8d0e-3c36-4c59-8efd-54519839e56a
212<span class="hljs-meta">
213$ </span><span class="language-bash">node -p <span class="hljs-string">'inspector.url()'</span></span>
214undefined</code></pre>
215</section><section><h3><code>inspector.waitForDebugger()</code><span><a class="mark" href="#inspector_inspector_waitfordebugger" id="inspector_inspector_waitfordebugger">#</a></span></h3>
216<div class="api_metadata">
217<span>Added in: v12.7.0</span>
218</div>
219<p>Blocks until a client (existing or connected later) has sent
220<code>Runtime.runIfWaitingForDebugger</code> command.</p>
221<p>An exception will be thrown if there is no active inspector.</p>
222</section><section><h3>Class: <code>inspector.Session</code><span><a class="mark" href="#inspector_class_inspector_session" id="inspector_class_inspector_session">#</a></span></h3>
223<ul>
224<li>Extends: <a href="events.html#events_class_eventemitter" class="type">&#x3C;EventEmitter></a></li>
225</ul>
226<p>The <code>inspector.Session</code> is used for dispatching messages to the V8 inspector
227back-end and receiving message responses and notifications.</p>
228<h4><code>new inspector.Session()</code><span><a class="mark" href="#inspector_new_inspector_session" id="inspector_new_inspector_session">#</a></span></h4>
229<div class="api_metadata">
230<span>Added in: v8.0.0</span>
231</div>
232<p>Create a new instance of the <code>inspector.Session</code> class. The inspector session
233needs to be connected through <a href="#inspector_session_connect"><code>session.connect()</code></a> before the messages
234can be dispatched to the inspector backend.</p>
235<h4>Event: <code>'inspectorNotification'</code><span><a class="mark" href="#inspector_event_inspectornotification" id="inspector_event_inspectornotification">#</a></span></h4>
236<div class="api_metadata">
237<span>Added in: v8.0.0</span>
238</div>
239<ul>
240<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type">&#x3C;Object></a> The notification message object</li>
241</ul>
242<p>Emitted when any notification from the V8 Inspector is received.</p>
243<pre><code class="language-js">session.<span class="hljs-title function_">on</span>(<span class="hljs-string">'inspectorNotification'</span>, <span class="hljs-function">(<span class="hljs-params">message</span>) =></span> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(message.<span class="hljs-property">method</span>));
244<span class="hljs-comment">// Debugger.paused</span>
245<span class="hljs-comment">// Debugger.resumed</span></code></pre>
246<p>It is also possible to subscribe only to notifications with specific method:</p>
247<h4>Event: <code>&#x3C;inspector-protocol-method></code>;<span><a class="mark" href="#inspector_event_inspector_protocol_method" id="inspector_event_inspector_protocol_method">#</a></span></h4>
248<div class="api_metadata">
249<span>Added in: v8.0.0</span>
250</div>
251<ul>
252<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type">&#x3C;Object></a> The notification message object</li>
253</ul>
254<p>Emitted when an inspector notification is received that has its method field set
255to the <code>&#x3C;inspector-protocol-method></code> value.</p>
256<p>The following snippet installs a listener on the <a href="https://chromedevtools.github.io/devtools-protocol/v8/Debugger#event-paused"><code>'Debugger.paused'</code></a>
257event, and prints the reason for program suspension whenever program
258execution is suspended (through breakpoints, for example):</p>
259<pre><code class="language-js">session.<span class="hljs-title function_">on</span>(<span class="hljs-string">'Debugger.paused'</span>, <span class="hljs-function">(<span class="hljs-params">{ params }</span>) =></span> {
260  <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(params.<span class="hljs-property">hitBreakpoints</span>);
261});
262<span class="hljs-comment">// [ '/the/file/that/has/the/breakpoint.js:11:0' ]</span></code></pre>
263<h4><code>session.connect()</code><span><a class="mark" href="#inspector_session_connect" id="inspector_session_connect">#</a></span></h4>
264<div class="api_metadata">
265<span>Added in: v8.0.0</span>
266</div>
267<p>Connects a session to the inspector back-end.</p>
268<h4><code>session.connectToMainThread()</code><span><a class="mark" href="#inspector_session_connecttomainthread" id="inspector_session_connecttomainthread">#</a></span></h4>
269<div class="api_metadata">
270<span>Added in: v12.11.0</span>
271</div>
272<p>Connects a session to the main thread inspector back-end. An exception will
273be thrown if this API was not called on a Worker thread.</p>
274<h4><code>session.disconnect()</code><span><a class="mark" href="#inspector_session_disconnect" id="inspector_session_disconnect">#</a></span></h4>
275<div class="api_metadata">
276<span>Added in: v8.0.0</span>
277</div>
278<p>Immediately close the session. All pending message callbacks will be called
279with an error. <a href="#inspector_session_connect"><code>session.connect()</code></a> will need to be called to be able to send
280messages again. Reconnected session will lose all inspector state, such as
281enabled agents or configured breakpoints.</p>
282<h4><code>session.post(method[, params][, callback])</code><span><a class="mark" href="#inspector_session_post_method_params_callback" id="inspector_session_post_method_params_callback">#</a></span></h4>
283<div class="api_metadata">
284<span>Added in: v8.0.0</span>
285</div>
286<ul>
287<li><code>method</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string></a></li>
288<li><code>params</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type">&#x3C;Object></a></li>
289<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type">&#x3C;Function></a></li>
290</ul>
291<p>Posts a message to the inspector back-end. <code>callback</code> will be notified when
292a response is received. <code>callback</code> is a function that accepts two optional
293arguments: error and message-specific result.</p>
294<pre><code class="language-js">session.<span class="hljs-title function_">post</span>(<span class="hljs-string">'Runtime.evaluate'</span>, { <span class="hljs-attr">expression</span>: <span class="hljs-string">'2 + 2'</span> },
295             <span class="hljs-function">(<span class="hljs-params">error, { result }</span>) =></span> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(result));
296<span class="hljs-comment">// Output: { type: 'number', value: 4, description: '4' }</span></code></pre>
297<p>The latest version of the V8 inspector protocol is published on the
298<a href="https://chromedevtools.github.io/devtools-protocol/v8/">Chrome DevTools Protocol Viewer</a>.</p>
299<p>Node.js inspector supports all the Chrome DevTools Protocol domains declared
300by V8. Chrome DevTools Protocol domain provides an interface for interacting
301with one of the runtime agents used to inspect the application state and listen
302to the run-time events.</p>
303</section><section><h3>Example usage<span><a class="mark" href="#inspector_example_usage" id="inspector_example_usage">#</a></span></h3>
304<p>Apart from the debugger, various V8 Profilers are available through the DevTools
305protocol.</p>
306<h4>CPU profiler<span><a class="mark" href="#inspector_cpu_profiler" id="inspector_cpu_profiler">#</a></span></h4>
307<p>Here's an example showing how to use the <a href="https://chromedevtools.github.io/devtools-protocol/v8/Profiler">CPU Profiler</a>:</p>
308<pre><code class="language-js"><span class="hljs-keyword">const</span> inspector = <span class="hljs-built_in">require</span>(<span class="hljs-string">'inspector'</span>);
309<span class="hljs-keyword">const</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'fs'</span>);
310<span class="hljs-keyword">const</span> session = <span class="hljs-keyword">new</span> inspector.<span class="hljs-title class_">Session</span>();
311session.<span class="hljs-title function_">connect</span>();
312
313session.<span class="hljs-title function_">post</span>(<span class="hljs-string">'Profiler.enable'</span>, <span class="hljs-function">() =></span> {
314  session.<span class="hljs-title function_">post</span>(<span class="hljs-string">'Profiler.start'</span>, <span class="hljs-function">() =></span> {
315    <span class="hljs-comment">// Invoke business logic under measurement here...</span>
316
317    <span class="hljs-comment">// some time later...</span>
318    session.<span class="hljs-title function_">post</span>(<span class="hljs-string">'Profiler.stop'</span>, <span class="hljs-function">(<span class="hljs-params">err, { profile }</span>) =></span> {
319      <span class="hljs-comment">// Write profile to disk, upload, etc.</span>
320      <span class="hljs-keyword">if</span> (!err) {
321        fs.<span class="hljs-title function_">writeFileSync</span>(<span class="hljs-string">'./profile.cpuprofile'</span>, <span class="hljs-variable constant_">JSON</span>.<span class="hljs-title function_">stringify</span>(profile));
322      }
323    });
324  });
325});</code></pre>
326<h4>Heap profiler<span><a class="mark" href="#inspector_heap_profiler" id="inspector_heap_profiler">#</a></span></h4>
327<p>Here's an example showing how to use the <a href="https://chromedevtools.github.io/devtools-protocol/v8/HeapProfiler">Heap Profiler</a>:</p>
328<pre><code class="language-js"><span class="hljs-keyword">const</span> inspector = <span class="hljs-built_in">require</span>(<span class="hljs-string">'inspector'</span>);
329<span class="hljs-keyword">const</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'fs'</span>);
330<span class="hljs-keyword">const</span> session = <span class="hljs-keyword">new</span> inspector.<span class="hljs-title class_">Session</span>();
331
332<span class="hljs-keyword">const</span> fd = fs.<span class="hljs-title function_">openSync</span>(<span class="hljs-string">'profile.heapsnapshot'</span>, <span class="hljs-string">'w'</span>);
333
334session.<span class="hljs-title function_">connect</span>();
335
336session.<span class="hljs-title function_">on</span>(<span class="hljs-string">'HeapProfiler.addHeapSnapshotChunk'</span>, <span class="hljs-function">(<span class="hljs-params">m</span>) =></span> {
337  fs.<span class="hljs-title function_">writeSync</span>(fd, m.<span class="hljs-property">params</span>.<span class="hljs-property">chunk</span>);
338});
339
340session.<span class="hljs-title function_">post</span>(<span class="hljs-string">'HeapProfiler.takeHeapSnapshot'</span>, <span class="hljs-literal">null</span>, <span class="hljs-function">(<span class="hljs-params">err, r</span>) =></span> {
341  <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'HeapProfiler.takeHeapSnapshot done:'</span>, err, r);
342  session.<span class="hljs-title function_">disconnect</span>();
343  fs.<span class="hljs-title function_">closeSync</span>(fd);
344});</code></pre></section>
345        <!-- API END -->
346      </div>
347    </div>
348  </div>
349  <script>
350    'use strict';
351    {
352      const kCustomPreference = 'customDarkTheme';
353      const userSettings = sessionStorage.getItem(kCustomPreference);
354      const themeToggleButton = document.getElementById('theme-toggle-btn');
355      if (userSettings === null && window.matchMedia) {
356        const mq = window.matchMedia('(prefers-color-scheme: dark)');
357        if ('onchange' in mq) {
358          function mqChangeListener(e) {
359            document.body.classList.toggle('dark-mode', e.matches);
360          }
361          mq.addEventListener('change', mqChangeListener);
362          if (themeToggleButton) {
363            themeToggleButton.addEventListener('click', function() {
364              mq.removeEventListener('change', mqChangeListener);
365            }, { once: true });
366          }
367        }
368        if (mq.matches) {
369          document.body.classList.add('dark-mode');
370        }
371      } else if (userSettings === 'true') {
372        document.body.classList.add('dark-mode');
373      }
374      if (themeToggleButton) {
375        themeToggleButton.hidden = false;
376        themeToggleButton.addEventListener('click', function() {
377          sessionStorage.setItem(
378            kCustomPreference,
379            document.body.classList.toggle('dark-mode')
380          );
381        });
382      }
383    }
384  </script>
385</body>
386</html>
387