Global

Methods

complete_request(request)

Handler for `complete_request` messages
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

complete_request(request)

Handler for `complete_request` messages
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

execute_request(request)

Handler for `execute_request` messages
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

execute_request(request)

Handler for `execute_request` messages
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

history_request(request)

Handler for `history_request` messages
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

history_request(request)

Handler for `history_request` messages
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

inspect_request(request)

Handler for `inspect_request` messages
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

kernel_info_request(request)

Handler for `kernel_info_request` messages
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

kernel_info_request(request)

Handler for `kernel_info_request` messages
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

object_info_request(request)

Handler for `object_info_request` messages
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

shutdown_request(request)

Handler for `shutdown_request` messages
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

shutdown_request(request)

Handler for `shutdown_request` messages
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

status_busy(request)

Send `status_busy` message
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

status_busy(request)

Send `status_busy` message
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

status_idle(request)

Send for `status_idle` message
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

status_idle(request)

Send for `status_idle` message
This:
Parameters:
Name Type Description
request module:jmp~Message Request message
Source:

Type Definitions

Config

Kernel configuration.
Properties:
Name Type Attributes Description
connection object Frontend connection file
cwd string Session current working directory
debug boolean Enable debug mode
hideExecutionResult boolean Do not show execution results
hideUndefined boolean Do not show undefined results
kernelInfoReply object Content of kernel_info_reply message
protocolVersion string Message protocol version
startupCallback StartupCB Callback invoked at session startup. This callback can be used to setup a session; e.g. to register a require extensions.
startupScript string Path to a script to be run at startup. Path to a folder also accepted, in which case all the scripts in the folder will be run.
transpile module:nel~Transpiler <nullable>
 If defined, this function transpiles the request code into Javascript that can be run by the Node.js session.
Source:

DestroyCB(codenullable, signalnullable)

Callback run after the session server has been killed and before the sockets have been closed
Parameters:
Name Type Attributes Description
code Number <nullable>
 Exit code from session server if exited normally
signal String <nullable>
 Signal passed to kill the session server
Source:
See:
  • Kernel.destroy

RestartCB(codenullable, signalnullable)

Callback run after the session server has been restarted
Parameters:
Name Type Attributes Description
code Number <nullable>
 Exit code from session server if exited normally
signal String <nullable>
 Signal passed to kill the session server
Source:
See:
  • Kernel.restart

StartupCB()

Callback run at session startup (this callback can be used to setup the kernel session; e.g. to register a require extensions).
This:
Source: