Constructor
new Session(nelConfigopt)
Parameters:
| Name |
Type |
Attributes |
Description |
nelConfig |
module:nel~Config
|
<optional>
|
Session configuration. |
- Source:
Members
Function that transpiles the request code into Javascript that can be run
by the Node.js session (null/undefined if no transpilation is needed).
Type:
- Source:
Methods
complete(code, cursorPos, callbacksopt)
Complete a Javascript expression
Parameters:
| Name |
Type |
Attributes |
Description |
code |
String
|
|
Javascript code |
cursorPos |
Number
|
|
Cursor position in code |
callbacks |
|
<optional>
|
Properties
| Name |
Type |
Attributes |
Description |
onSuccess |
OnCompletionSuccessCB
|
<optional>
|
|
onError |
OnErrorCB
|
<optional>
|
|
beforeRun |
BeforeRunCB
|
<optional>
|
|
afterRun |
AfterRunCB
|
<optional>
|
|
onStdout |
OnStdioCB
|
<optional>
|
|
onStderr |
OnStdioCB
|
<optional>
|
|
|
- Source:
execute(code, callbacksopt)
Make an execution request
Parameters:
| Name |
Type |
Attributes |
Description |
code |
String
|
|
Code to execute in session |
callbacks |
|
<optional>
|
Properties
| Name |
Type |
Attributes |
Description |
onSuccess |
OnExecutionSuccessCB
|
<optional>
|
|
onError |
OnErrorCB
|
<optional>
|
|
beforeRun |
BeforeRunCB
|
<optional>
|
|
afterRun |
AfterRunCB
|
<optional>
|
|
onStdout |
OnStdioCB
|
<optional>
|
|
onStderr |
OnStdioCB
|
<optional>
|
|
onDisplay |
OnDisplayCB
|
<optional>
|
|
onRequest |
OnRequestCB
|
<optional>
|
|
|
- Source:
inspect(code, cursorPos, callbacksopt)
Inspect a Javascript expression
Parameters:
| Name |
Type |
Attributes |
Description |
code |
String
|
|
Javascript code |
cursorPos |
Number
|
|
Cursor position in code |
callbacks |
|
<optional>
|
Properties
| Name |
Type |
Attributes |
Description |
onSuccess |
OnInspectionSuccessCB
|
<optional>
|
|
onError |
OnErrorCB
|
<optional>
|
|
beforeRun |
BeforeRunCB
|
<optional>
|
|
afterRun |
AfterRunCB
|
<optional>
|
|
onStdout |
OnStdioCB
|
<optional>
|
|
onStderr |
OnStdioCB
|
<optional>
|
|
|
- Source:
kill(signalopt, killCBopt)
Kill session
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
signal |
String
|
<optional>
|
"SIGTERM"
|
Signal passed to kill the
session server |
killCB |
module:nel~KillCB
|
<optional>
|
|
Callback run after the
session server has been
killed |
- Source:
restart(signalopt, restartCBopt)
Restart session
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
signal |
String
|
<optional>
|
"SIGTERM"
|
Signal passed to kill the
old session |
restartCB |
module:nel~RestartCB
|
<optional>
|
|
Callback run after restart |
- Source: