Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2021-10-11 07:55:04 +0300
committerAntoine du Hamel <duhamelantoine1995@gmail.com>2021-10-20 12:59:11 +0300
commitd0b58c0287e67a139137aa906819d95f8314b093 (patch)
treee9a92870138d89b608b1c6e6568611744c32c4f2 /doc/api/inspector.md
parenta7c17e08de658cbc0beefd8e9583803b5a62ac7e (diff)
doc: format doc/api/*.md with markdown formatter
PR-URL: https://github.com/nodejs/node/pull/40403 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Michaƫl Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Diffstat (limited to 'doc/api/inspector.md')
-rw-r--r--doc/api/inspector.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/api/inspector.md b/doc/api/inspector.md
index 04b0283d8cc..3d0dbf7799e 100644
--- a/doc/api/inspector.md
+++ b/doc/api/inspector.md
@@ -38,8 +38,8 @@ console.
* `wait` {boolean} Block until a client has connected. Optional.
**Default:** `false`.
-Activate inspector on host and port. Equivalent to `node
---inspect=[[host:]port]`, but can be done programmatically after node has
+Activate inspector on host and port. Equivalent to
+`node --inspect=[[host:]port]`, but can be done programmatically after node has
started.
If wait is `true`, will block until a client has connected to the inspect port
@@ -70,6 +70,7 @@ undefined
```
## `inspector.waitForDebugger()`
+
<!-- YAML
added: v12.7.0
-->
@@ -87,6 +88,7 @@ The `inspector.Session` is used for dispatching messages to the V8 inspector
back-end and receiving message responses and notifications.
### `new inspector.Session()`
+
<!-- YAML
added: v8.0.0
-->
@@ -96,6 +98,7 @@ needs to be connected through [`session.connect()`][] before the messages
can be dispatched to the inspector backend.
### Event: `'inspectorNotification'`
+
<!-- YAML
added: v8.0.0
-->
@@ -113,6 +116,7 @@ session.on('inspectorNotification', (message) => console.log(message.method));
It is also possible to subscribe only to notifications with specific method:
### Event: `<inspector-protocol-method>`;
+
<!-- YAML
added: v8.0.0
-->
@@ -134,6 +138,7 @@ session.on('Debugger.paused', ({ params }) => {
```
### `session.connect()`
+
<!-- YAML
added: v8.0.0
-->
@@ -141,6 +146,7 @@ added: v8.0.0
Connects a session to the inspector back-end.
### `session.connectToMainThread()`
+
<!-- YAML
added: v12.11.0
-->
@@ -149,6 +155,7 @@ Connects a session to the main thread inspector back-end. An exception will
be thrown if this API was not called on a Worker thread.
### `session.disconnect()`
+
<!-- YAML
added: v8.0.0
-->
@@ -159,6 +166,7 @@ messages again. Reconnected session will lose all inspector state, such as
enabled agents or configured breakpoints.
### `session.post(method[, params][, callback])`
+
<!-- YAML
added: v8.0.0
-->