jpeek 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
Interactive fold/unfold JSON tree viewer for the terminal. Zero deps.
|
|
4
4
|
|
|
5
|
+
> ⚠️ **Debug tool only.** Solely for inspecting JSON data in a terminal during
|
|
6
|
+
> local development. `interact`/`render` block the Node process synchronously
|
|
7
|
+
> until you quit, no other code runs while open. Do not call from request
|
|
8
|
+
> handlers, servers, or any production/deployed code path.
|
|
9
|
+
|
|
5
10
|
## Install
|
|
6
11
|
|
|
7
12
|
```sh
|
|
@@ -16,12 +21,11 @@ const { jpeek } = require('jpeek');
|
|
|
16
21
|
jpeek.interact('my data', { hello: 'world', list: [1, 2, 3] });
|
|
17
22
|
```
|
|
18
23
|
|
|
19
|
-
`jpeek.interact(name, data)` opens an interactive tree in the terminal.
|
|
20
|
-
synchronously until you quit — no `await` needed.
|
|
24
|
+
`jpeek.interact(name, data)` opens an interactive tree in the terminal.
|
|
21
25
|
|
|
22
|
-
- `↑`/`↓` (
|
|
23
|
-
- `→`/`enter` — expand
|
|
24
|
-
- `←` — collapse / go to parent
|
|
26
|
+
- `↑`/`↓` (Up Arrow/Down Arrow) — navigate
|
|
27
|
+
- `→`/`enter` (Right Arrow) — expand
|
|
28
|
+
- `←` (Left Arrow) — collapse / go to parent
|
|
25
29
|
- `space` — toggle
|
|
26
30
|
- `q` / `esc` / `ctrl-c` — quit
|
|
27
31
|
|