Skip to content
Browse files

formatting?

  • Loading branch information...
1 parent d0d6d2a commit f5f1153375a4da6943bd486644248ef88f7e0fa0 @seth4618 committed May 21, 2012
Showing with 17 additions and 17 deletions.
  1. +17 −17 README.md
View
34 README.md
@@ -11,32 +11,32 @@ CLI for inspecting the heap of a node application
The program undertest needs to run a tcpserver which you get from:
- var heapserver = require('heapserver.js'); // include basic code
- heapserver(port); // start heapserver on port 'port'
+ var heapserver = require('heapserver.js'); // include basic code
+ heapserver(port); // start heapserver on port 'port'
For example, in my code I define a runtime argument profileMemOn and profilePort and do the following:
- if (profileMemOn) {
- HeapServer = (/** @type {function (number, boolean=):?} */require('heapserver.js'));
- HeapServer(profilePort);
- }
+ if (profileMemOn) {
+ HeapServer = (/** @type {function (number, boolean=):?} */require('heapserver.js'));
+ HeapServer(profilePort);
+ }
Then to see what is going on run the command:
- nodeheap --port <port>
+ nodeheap --port <port>
- on the command line will connect to the program undertest. The following commands are available:
+on the command line will connect to the program undertest. The following commands are available:
- login: gets things started
- quit: will exit
- help: print a set of commands
+- *login*: gets things started
+- *quit*: will exit
+- *help*: print a set of commands
- base: Will set the base profile to the last profile used. Or, if none has been used will create a profile.
- comp: Will compare the current heap profile with whatever was set as the base profile.
- info <type> <name>: show information on all objects of type 'type'
+- *base*: Will set the base profile to the last profile used. Or, if none has been used will create a profile.
+- *comp*: Will compare the current heap profile with whatever was set as the base profile.
+- *info* <type> <name>: show information on all objects of type 'type'
with name 'name'. A '*' in either will include everything.
I.e., info Object * will show all objects, while info Object
Foo will only show those objects with the name Foo.
- chain <id>: will show the retainer chain for object with id, <id>.
- value <id>: will show the value of object with id <id>.
- inspect <id> <path>: will show the value of the object <id>.<path>
+- *chain* <id>: will show the retainer chain for object with id, <id>.
+- *value* <id>: will show the value of object with id <id>.
+- *inspect* <id> <path>: will show the value of the object <id>.<path>

0 comments on commit f5f1153

Please sign in to comment.
Something went wrong with that request. Please try again.